]>
git.saurik.com Git - wxWidgets.git/blob - interface/colour.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxColour
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 A colour is an object representing a combination of Red, Green, and Blue
14 (RGB) intensity values, and is used to determine drawing colours. See the
15 entry for wxColourDatabase for how a pointer to a predefined, named colour
16 may be returned instead of creating a new colour.
18 Valid RGB values are in the range 0 to 255.
20 You can retrieve the current system colour settings with wxSystemSettings.
26 ::wxNullColour, ::wxBLACK, ::wxWHITE, ::wxRED, ::wxBLUE, ::wxGREEN,
27 ::wxCYAN, ::wxLIGHT_GREY
29 @see wxColourDatabase, wxPen, wxBrush, wxColourDialog, wxSystemSettings
31 class wxColour
: public wxObject
48 The alpha value. Alpha values range from 0 (wxALPHA_TRANSPARENT) to
51 wxColour(unsigned char red
, unsigned char green
, unsigned char blue
,
52 unsigned char alpha
= wxALPHA_OPAQUE
);
58 wxColour(const wxString
& colourName
);
63 wxColour(const wxColour
& colour
);
66 Returns the alpha value, on platforms where alpha is not yet supported, this
67 always returns wxALPHA_OPAQUE.
69 unsigned char Alpha() const;
72 Returns the blue intensity.
74 unsigned char Blue() const;
77 Converts this colour to a wxString using the given flags.
79 The supported flags are wxC2S_NAME, to obtain the colour name (e.g.
80 wxColour(255,0,0) == "red"), wxC2S_CSS_SYNTAX, to obtain the colour in
81 the "rgb(r,g,b)" or "rgba(r,g,b,a)" syntax (e.g.
82 wxColour(255,0,0,85) == "rgba(255,0,0,0.333)"), and wxC2S_HTML_SYNTAX,
83 to obtain the colour as "#" followed by 6 hexadecimal digits (e.g.
84 wxColour(255,0,0) == "#FF0000").
86 This function never fails and always returns a non-empty string but
87 asserts if the colour has alpha channel (i.e. is non opaque) but
88 wxC2S_CSS_SYNTAX (which is the only one supporting alpha) is not
93 wxString
GetAsString(long flags
);
96 Returns a pixel value which is platform-dependent. On Windows, a COLORREF is
98 On X, an allocated pixel value is returned.
99 -1 is returned if the pixel is invalid (on X, unallocated).
101 long GetPixel() const;
104 Returns the green intensity.
106 unsigned char Green() const;
109 Returns @true if the colour object is valid (the colour has been initialised
115 Returns the red intensity.
117 unsigned char Red() const;
121 Sets the RGB intensity values using the given values (first overload),
122 extracting them from the packed long (second overload), using the given
123 string (third overloard).
125 When using third form, Set() accepts: colour names (those listed in
126 wxTheColourDatabase()), the CSS-like @c "rgb(r,g,b)" or
127 @c "rgba(r,g,b,a)" syntax (case insensitive) and the HTML-like syntax
128 (i.e. @c "#" followed by 6 hexadecimal digits for red, green, blue
131 Returns @true if the conversion was successful, @false otherwise.
135 void Set(unsigned char red
, unsigned char green
,
137 unsigned char alpha
= wxALPHA_OPAQUE
);
138 void Set(unsigned long RGB
);
139 bool Set(const wxString
& str
);
143 Tests the inequality of two colours by comparing individual red, green, blue
144 colours and alpha values.
146 bool operator !=(const wxColour
& colour
);
150 Assignment operator, using a colour name to be found in the colour database.
152 @see wxColourDatabase
154 wxColour
operator =(const wxColour
& colour
);
155 wxColour
operator =(const wxString
& colourName
);
159 Tests the equality of two colours by comparing individual red, green, blue
160 colours and alpha values.
162 bool operator ==(const wxColour
& colour
);
169 wxColour wxNullColour
;
204 wxColour wxLIGHT_GREY
;
208 // ============================================================================
209 // Global functions/macros
210 // ============================================================================
212 /** @ingroup group_funcmacro_misc */
216 Converts string to a wxColour best represented by the given string. Returns
219 @see wxToString(const wxColour&)
223 bool wxFromString(const wxString
& string
, wxColour
* colour
);
226 Converts the given wxColour into a string.
228 @see wxFromString(const wxString&, wxColour*)
232 wxString
wxToString(const wxColour
& colour
);