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.
You can retrieve the current system colour settings with wxSystemSettings.
Derived from
Include files
<wx/colour.h>
Predefined objects
Objects:
wxNullColour
Pointers:
wxBLACK
wxWHITE
wxRED
wxBLUE
wxGREEN
wxCYAN
wxLIGHT_GREY
See also
wxColourDatabase, wxPen, wxBrush, wxColourDialog, wxSystemSettings
Members
wxColour::wxColour
wxColour::Blue
wxColour::GetAsString
wxColour::GetPixel
wxColour::Green
wxColour::Ok
wxColour::Red
wxColour::Set
wxColour::Set
wxColour::Set
wxColour::operator =
wxColour::operator ==
wxColour::operator !=
wxColour()
Default constructor.
wxColour(unsigned char red, unsigned char green, unsigned char blue)
Constructs a colour from red, green and blue values.
wxColour(const wxString& colourNname)
Constructs a colour using the given string. See Set for more info.
wxColour(const wxColour& colour)
Copy constructor.
Parameters
red
green
blue
colourName
colour
See also
wxPython note: Constructors supported by wxPython are:
wxColour(red=0, green=0, blue=0) | |
wxNamedColour(name) |
unsigned char Blue() const
Returns the blue intensity.
wxString GetAsString(long flags) const
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)" syntax (e.g. wxColour(255,0,0) -> "rgb(255,0,0)"), 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.
long GetPixel() const
Returns a pixel value which is platform-dependent. On Windows, a COLORREF is returned. On X, an allocated pixel value is returned.
-1 is returned if the pixel is invalid (on X, unallocated).
unsigned char Green() const
Returns the green intensity.
bool Ok() const
Returns true if the colour object is valid (the colour has been initialised with RGB values).
unsigned char Red() const
Returns the red intensity.
void Set(unsigned char red, unsigned char green, unsigned char blue)
Sets the RGB intensity values.
void Set(unsigned long RGB)
Sets the RGB intensity values extracting them from the packed long.
bool Set(const wxString & str)
Sets the colour using the given string. Accepts colour names (those listed in wxTheColourDatabase), the CSS-like "RGB(r,g,b)" syntax (case insensitive) and the HTML-like syntax (i.e. "#" followed by 6 hexadecimal digits for red, green, blue components).
Returns true if the conversion was successful, false otherwise.
wxColour& operator =(const wxColour& colour)
Assignment operator, taking another colour object.
wxColour& operator =(const wxString& colourName)
Assignment operator, using a colour name to be found in the colour database.
See also
bool operator ==(const wxColour& colour)
Tests the equality of two colours by comparing individual red, green blue colours.
bool operator !=(const wxColour& colour)
Tests the inequality of two colours by comparing individual red, green blue colours.