X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..838bfb19e02839b57778ef71963505b27a7ea758:/interface/clrpicker.h

diff --git a/interface/clrpicker.h b/interface/clrpicker.h
index f8dada178f..062c134d13 100644
--- a/interface/clrpicker.h
+++ b/interface/clrpicker.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        clrpicker.h
-// Purpose:     documentation for wxColourPickerCtrl class
+// Purpose:     interface of wxColourPickerCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,43 +9,48 @@
 /**
     @class wxColourPickerCtrl
     @wxheader{clrpicker.h}
-    
-    This control allows the user to select a colour. The generic implementation is
-    a button which brings up a wxColourDialog when clicked. Native implementation
-    may differ but this is usually a (small) widget which give access to the
-    colour-chooser
-    dialog.
-    It is only available if @c wxUSE_COLOURPICKERCTRL is set to 1 (the default).
-    
+
+    This control allows the user to select a colour. The generic implementation
+    is a button which brings up a wxColourDialog when clicked. Native
+    implementation may differ but this is usually a (small) widget which give
+    access to the colour-chooser dialog. It is only available if
+    @c wxUSE_COLOURPICKERCTRL is set to 1 (the default).
+
     @beginStyleTable
-    @style{wxCLRP_DEFAULT_STYLE}:
+    @style{wxCLRP_DEFAULT_STYLE}
            The default style: 0.
-    @style{wxCLRP_USE_TEXTCTRL}:
+    @style{wxCLRP_USE_TEXTCTRL}
            Creates a text control to the left of the picker button which is
            completely managed by the wxColourPickerCtrl and which can be used
            by the user to specify a colour (see SetColour). The text control
            is automatically synchronized with button's value. Use functions
            defined in wxPickerBase to modify the text control.
-    @style{wxCLRP_SHOW_LABEL}:
+    @style{wxCLRP_SHOW_LABEL}
            Shows the colour in HTML form (AABBCC) as colour button label
            (instead of no label at all).
     @endStyleTable
-    
+
+    @beginEventTable{wxColourPickerEvent}
+    @event{EVT_COLOURPICKER_CHANGED(id, func)}
+           The user changed the colour selected in the control either using the
+           button or using text control (see @c wxCLRP_USE_TEXTCTRL; note that
+           in this case the event is fired only if the user’s input is valid,
+           i.e. recognizable).
+    @endEventTable
+
     @library{wxcore}
-    @category{miscpickers}
-    @appearance{colourpickerctrl.png}
-    
-    @seealso
-    wxColourDialog, wxColourPickerEvent
+    @category{pickers}
+    <!-- @appearance{colourpickerctrl.png} -->
+
+    @see wxColourDialog, wxColourPickerEvent
 */
 class wxColourPickerCtrl : public wxPickerBase
 {
 public:
     /**
-        Initializes the object and calls Create() with
-        all the parameters.
+        Initializes the object and calls Create() with all the parameters.
     */
-    wxColourPickerCtrl(wxWindow * parent, wxWindowID id,
+    wxColourPickerCtrl(wxWindow* parent, wxWindowID id,
                        const wxColour& colour = wxBLACK,
                        const wxPoint& pos = wxDefaultPosition,
                        const wxSize& size = wxDefaultSize,
@@ -54,34 +59,29 @@ public:
                        const wxString& name = "colourpickerctrl");
 
     /**
-        @param parent 
-        Parent window, must not be non-@NULL.
-        
-        @param id 
-        The identifier for the control.
-        
-        @param colour 
-        The initial colour shown in the control.
-        
-        @param pos 
-        Initial position.
-        
-        @param size 
-        Initial size.
-        
-        @param style 
-        The window style, see wxCRLP_* flags.
-        
-        @param validator 
-        Validator which can be used for additional date checks.
-        
-        @param name 
-        Control name.
-        
-        @returns @true if the control was successfully created or @false if
-                   creation failed.
+        Creates a colour picker with the given arguments.
+
+        @param parent
+            Parent window, must not be non-@NULL.
+        @param id
+            The identifier for the control.
+        @param colour
+            The initial colour shown in the control.
+        @param pos
+            Initial position.
+        @param size
+            Initial size.
+        @param style
+            The window style, see wxCRLP_* flags.
+        @param validator
+            Validator which can be used for additional date checks.
+        @param name
+            Control name.
+
+        @return @true if the control was successfully created or @false if
+                creation failed.
     */
-    bool Create(wxWindow * parent, wxWindowID id,
+    bool Create(wxWindow* parent, wxWindowID id,
                 const wxColour& colour = wxBLACK,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
@@ -92,30 +92,34 @@ public:
     /**
         Returns the currently selected colour.
     */
-    wxColour GetColour();
+    wxColour GetColour() const;
 
     //@{
     /**
-        Sets the currently selected colour. See wxColour::Set.
+        Sets the currently selected colour. See wxColour::Set().
     */
-    void SetColour(const wxColour & col);
-        void SetColour(const wxString & colname);
+    void SetColour(const wxColour& col);
+    void SetColour(const wxString& colname);
     //@}
 };
 
 
+
 /**
     @class wxColourPickerEvent
     @wxheader{clrpicker.h}
-    
-    This event class is used for the events generated by
-    wxColourPickerCtrl.
-    
+
+    This event class is used for the events generated by wxColourPickerCtrl.
+
+    @beginEventTable{wxColourPickerEvent}
+    @event{EVT_COLOURPICKER_CHANGED(id, func)}
+           Generated whenever the selected colour changes.
+    @endEventTable
+
     @library{wxcore}
-    @category{FIXME}
-    
-    @seealso
-    wxColourPickerCtrl
+    @category{events}
+
+    @see wxColourPickerCtrl
 */
 class wxColourPickerEvent : public wxCommandEvent
 {
@@ -123,16 +127,17 @@ public:
     /**
         The constructor is not normally used by the user code.
     */
-    wxColourPickerEvent(wxObject * generator, int id,
+    wxColourPickerEvent(wxObject* generator, int id,
                         const wxColour& colour);
 
     /**
         Retrieve the colour the user has just selected.
     */
-    wxColour GetColour();
+    wxColour GetColour() const;
 
     /**
         Set the colour associated with the event.
     */
-    void SetColour(const wxColour & pos);
+    void SetColour(const wxColour& pos);
 };
+