[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    koffice/libs/guiutils (silent)
From:       Fredy Yanardi <fyanardi () gmail ! com>
Date:       2007-08-15 11:56:34
Message-ID: 1187178994.438718.2485.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 700379 by fyanardi:

SVN_SILENT add apidocs


 M  +8 -0      KoColorPatch.h  
 M  +1 -1      KoColorSetWidget.h  
 M  +20 -0     KoEditColorSetDialog.h  


--- trunk/koffice/libs/guiutils/KoColorPatch.h #700378:700379
@@ -34,7 +34,15 @@
     explicit KoColorPatch( QWidget *parent );
     virtual ~KoColorPatch();
 
+    /**
+     * Set the color of this color patch
+     * @param c the new color
+     */
     void setColor( const KoColor c );
+
+    /**
+     * @return current color shown by this patch
+     */
     KoColor color() const;
 
 protected:
--- trunk/koffice/libs/guiutils/KoColorSetWidget.h #700378:700379
@@ -72,7 +72,7 @@
     void setColorSet(KoColorSet *colorSet);
 
 protected:
-    virtual void resizeEvent(QResizeEvent *event);
+    virtual void resizeEvent(QResizeEvent *event); ///< reimplemented from QFrame
 
 signals:
 
--- trunk/koffice/libs/guiutils/KoEditColorSetDialog.h #700378:700379
@@ -56,12 +56,32 @@
     KoColorPatch *m_activePatch;
 };
 
+/**
+ * A dialog for editing palettes/color sets in an application. Example use of this \
dialog is in text color toolbar, + * the toolbar brings a set of colors from one \
palette, and a button brings this dialog for editing palettes. + * This dialog is \
able to: + * - Set active palette from a combobox
+ * - Add/remove color from a palette
+ * - Open new palette from a gimp palette file (.gpl)
+ * - Save changes to the file
+ * @see KoColorSetWidget
+ */
 class KOGUIUTILS_EXPORT KoEditColorSetDialog : public KDialog
 {
     Q_OBJECT
 
 public:
+    /**
+     * Constructs a KoEditColorSetDialog.
+     * @param palettes all availabe palettes that are going to be edited.
+     * @param activePalette name of the palette which will be activated after this \
dialog is shown. +     * @param parent the parent widget
+     */
     KoEditColorSetDialog(const QList<KoColorSet *> &palettes, const QString \
&activePalette, QWidget *parent = 0); +
+    /**
+     * @return the last active KoColorSet in the dialog before the user press OK
+     */
     KoColorSet *activeColorSet();
 
     /**


[prev in list] [next in list] [prev in thread] [next in thread]