X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..0ce6d6c89a540e707c4a91238e6460c0e4bae2a6:/interface/clrpicker.h diff --git a/interface/clrpicker.h b/interface/clrpicker.h index f862096299..387f99d1ab 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 @@ -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); }; +