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

diff --git a/interface/clrpicker.h b/interface/clrpicker.h
index f8dada178f..78c1059c08 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,14 +9,14 @@
 /**
     @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).
-    
+
     @beginStyleTable
     @style{wxCLRP_DEFAULT_STYLE}:
            The default style: 0.
@@ -30,13 +30,12 @@
            Shows the colour in HTML form (AABBCC) as colour button label
            (instead of no label at all).
     @endStyleTable
-    
+
     @library{wxcore}
     @category{miscpickers}
     @appearance{colourpickerctrl.png}
-    
-    @seealso
-    wxColourDialog, wxColourPickerEvent
+
+    @see wxColourDialog, wxColourPickerEvent
 */
 class wxColourPickerCtrl : public wxPickerBase
 {
@@ -45,7 +44,7 @@ public:
         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 +53,27 @@ 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.
+        @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.
+                 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 +84,30 @@ public:
     /**
         Returns the currently selected colour.
     */
-    wxColour GetColour();
+    wxColour GetColour() const;
 
     //@{
     /**
         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.
-    
+
     @library{wxcore}
     @category{FIXME}
-    
-    @seealso
-    wxColourPickerCtrl
+
+    @see wxColourPickerCtrl
 */
 class wxColourPickerEvent : public wxCommandEvent
 {
@@ -123,16 +115,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);
 };
+