]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/clrpicker.h
non-pch build fix
[wxWidgets.git] / interface / clrpicker.h
index f86209629921ff5857a8b6667f436e2b66de1538..387f99d1ab446605efbb6f19a781187e287d4b4c 100644 (file)
@@ -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
@@ -35,8 +35,7 @@
     @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,
@@ -55,33 +54,26 @@ public:
 
     /**
         @param parent
-        Parent window, must not be non-@NULL.
-        
+            Parent window, must not be non-@NULL.
         @param id
-        The identifier for the control.
-        
+            The identifier for the control.
         @param colour
-        The initial colour shown in the control.
-        
+            The initial colour shown in the control.
         @param pos
-        Initial position.
-        
+            Initial position.
         @param size
-        Initial size.
-        
+            Initial size.
         @param style
-        The window style, see wxCRLP_* flags.
-        
+            The window style, see wxCRLP_* flags.
         @param validator
-        Validator which can be used for additional date checks.
-        
+            Validator which can be used for additional date checks.
         @param name
-        Control 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,18 +84,19 @@ 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}
@@ -114,8 +107,7 @@ public:
     @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);
 };
+