X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e54c96f187f46c06bd36be8cd52b35c19884aa2b..de536319f16406adf967003637b2655c61f6cb09:/interface/colour.h diff --git a/interface/colour.h b/interface/colour.h index 9df414c4c7..52bc2f28d1 100644 --- a/interface/colour.h +++ b/interface/colour.h @@ -10,11 +10,10 @@ @class wxColour @wxheader{colour.h} - A colour is an object representing a combination of Red, Green, and Blue (RGB) - intensity values, - and is used to determine drawing colours. See the - entry for wxColourDatabase for how a pointer to a predefined, - named colour may be returned instead of creating a new colour. + A colour is an object representing a combination of Red, Green, and Blue + (RGB) intensity values, and is used to determine drawing colours. See the + entry for wxColourDatabase for how a pointer to a predefined, named colour + may be returned instead of creating a new colour. Valid RGB values are in the range 0 to 255. @@ -24,18 +23,27 @@ @category{gdi} @stdobjects - ::Objects:, ::wxNullColour, ::Pointers:, ::wxBLACK, ::wxWHITE, ::wxRED, - ::wxBLUE, ::wxGREEN, ::wxCYAN, ::wxLIGHT_GREY, + - ::wxNullColour - An empty, invalid colour. + - ::wxBLACK + - ::wxBLUE + - ::wxCYAN + - ::wxGREEN + - ::wxLIGHT_GREY + - ::wxRED + - ::wxWHITE @see wxColourDatabase, wxPen, wxBrush, wxColourDialog, wxSystemSettings */ class wxColour : public wxObject { public: - //@{ + + /** + Default constructor. + */ + wxColour(); + /** - Copy constructor. - @param red The red value. @param green @@ -43,22 +51,22 @@ public: @param blue The blue value. @param alpha - The alpha value. Alpha values range from 0 (wxALPHA_TRANSPARENT) to 255 - (wxALPHA_OPAQUE). + The alpha value. Alpha values range from 0 (wxALPHA_TRANSPARENT) to + 255 (wxALPHA_OPAQUE). + */ + wxColour(unsigned char red, unsigned char green, unsigned char blue, + unsigned char alpha = wxALPHA_OPAQUE); + + /** @param colourName The colour name. - @param colour - The colour to copy. - - @see wxColourDatabase */ - wxColour(); - wxColour(unsigned char red, unsigned char green, - unsigned char blue, - unsigned char alpha = wxALPHA_OPAQUE); - wxColour(const wxString& colourNname); + wxColour(const wxString& colourName); + + /** + Copy constructor. + */ wxColour(const wxColour& colour); - //@} /** Returns the alpha value, on platforms where alpha is not yet supported, this @@ -71,24 +79,24 @@ public: */ unsigned char Blue() const; - //@{ /** - is not + Converts this colour to a wxString using the given flags. + + The supported flags are wxC2S_NAME, to obtain the colour name (e.g. + wxColour(255,0,0) == "red"), wxC2S_CSS_SYNTAX, to obtain the colour in + the "rgb(r,g,b)" or "rgba(r,g,b,a)" syntax (e.g. + wxColour(255,0,0,85) == "rgba(255,0,0,0.333)"), and wxC2S_HTML_SYNTAX, + to obtain the colour as "#" followed by 6 hexadecimal digits (e.g. + wxColour(255,0,0) == "#FF0000"). + + This function never fails and always returns a non-empty string but + asserts if the colour has alpha channel (i.e. is non opaque) but + wxC2S_CSS_SYNTAX (which is the only one supporting alpha) is not specified in flags. - - @wxsince{2.7.0} + + @since 2.7.0 */ wxString GetAsString(long flags); - const wxC2S_NAME, to obtain the colour name (e.g. - wxColour(255,0,0) - "red"), wxC2S_CSS_SYNTAX, to obtain - the colour in the "rgb(r,g,b)" or "rgba(r,g,b,a)" syntax - (e.g. wxColour(255,0,0,85) - "rgba(255,0,0,0.333)"), and - wxC2S_HTML_SYNTAX, to obtain the colour as "#" followed - by 6 hexadecimal digits (e.g. wxColour(255,0,0) - "#FF0000"). - This function never fails and always returns a non-empty string but asserts if - the colour has alpha channel (i.e. is non opaque) but - wxC2S_CSS_SYNTAX(); - //@} /** Returns a pixel value which is platform-dependent. On Windows, a COLORREF is @@ -117,15 +125,18 @@ public: //@{ /** Sets the RGB intensity values using the given values (first overload), - extracting them from the packed long (second overload), using the given string (third overloard). + extracting them from the packed long (second overload), using the given + string (third overloard). + When using third form, Set() accepts: colour names (those listed in - wxTheColourDatabase()), the CSS-like - @c "rgb(r,g,b)" or @c "rgba(r,g,b,a)" syntax (case insensitive) - and the HTML-like syntax (i.e. @c "#" followed by 6 hexadecimal digits - for red, green, blue components). + wxTheColourDatabase()), the CSS-like @c "rgb(r,g,b)" or + @c "rgba(r,g,b,a)" syntax (case insensitive) and the HTML-like syntax + (i.e. @c "#" followed by 6 hexadecimal digits for red, green, blue + components). + Returns @true if the conversion was successful, @false otherwise. - - @wxsince{2.7.0} + + @since 2.7.0 */ void Set(unsigned char red, unsigned char green, unsigned char blue, @@ -143,7 +154,7 @@ public: //@{ /** Assignment operator, using a colour name to be found in the colour database. - + @see wxColourDatabase */ wxColour operator =(const wxColour& colour); @@ -158,56 +169,45 @@ public: }; -/** - FIXME -*/ -wxColour Objects: -; - -/** - FIXME -*/ +/** @name Predefined colors. */ +//@{ wxColour wxNullColour; +wxColour* wxBLACK; +wxColour* wxBLUE; +wxColour* wxCYAN; +wxColour* wxGREEN; +wxColour* wxLIGHT_GREY; +wxColour* wxRED; +wxColour* wxWHITE; +//@} -/** - FIXME -*/ -wxColour Pointers: -; -/** - FIXME -*/ -wxColour wxBLACK; -/** - FIXME -*/ -wxColour wxWHITE; +// ============================================================================ +// Global functions/macros +// ============================================================================ -/** - FIXME -*/ -wxColour wxRED; +/** @ingroup group_funcmacro_misc */ +//@{ /** - FIXME -*/ -wxColour wxBLUE; + Converts string to a wxColour best represented by the given string. Returns + @true on success. -/** - FIXME -*/ -wxColour wxGREEN; + @see wxToString(const wxColour&) -/** - FIXME + @header{wx/colour.h} */ -wxColour wxCYAN; +bool wxFromString(const wxString& string, wxColour* colour); /** - FIXME + Converts the given wxColour into a string. + + @see wxFromString(const wxString&, wxColour*) + + @header{wx/colour.h} */ -wxColour wxLIGHT_GREY; +wxString wxToString(const wxColour& colour); +//@}