#include <wx/colour.h>
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.
Predefined objects/pointers:
Public Member Functions | |
wxColour () | |
Default constructor. | |
wxColour (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=wxALPHA_OPAQUE) | |
wxColour (const wxString &colourName) | |
wxColour (const wxColour &colour) | |
Copy constructor. | |
virtual unsigned char | Alpha () const |
Returns the alpha value, on platforms where alpha is not yet supported, this always returns wxALPHA_OPAQUE. | |
virtual unsigned char | Blue () const |
Returns the blue intensity. | |
virtual wxString | GetAsString (long flags=wxC2S_NAME|wxC2S_CSS_SYNTAX) const |
Converts this colour to a wxString using the given flags. | |
int | GetPixel () const |
Returns a pixel value which is platform-dependent. | |
virtual unsigned char | Green () const |
Returns the green intensity. | |
virtual bool | IsOk () const |
Returns true if the colour object is valid (the colour has been initialised with RGB values). | |
virtual unsigned char | Red () const |
Returns the red intensity. | |
bool | operator!= (const wxColour &colour) const |
Tests the inequality of two colours by comparing individual red, green, blue colours and alpha values. | |
wxColour & | operator= (const wxColour &colour) |
Assignment operator, using a colour name to be found in the colour database. | |
bool | operator== (const wxColour &colour) const |
Tests the equality of two colours by comparing individual red, green, blue colours and alpha values. | |
void | Set (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=wxALPHA_OPAQUE) |
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). | |
void | Set (unsigned long RGB) |
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). | |
bool | Set (const wxString &str) |
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). |
wxColour::wxColour | ( | ) |
Default constructor.
wxColour::wxColour | ( | unsigned char | red, | |
unsigned char | green, | |||
unsigned char | blue, | |||
unsigned char | alpha = wxALPHA_OPAQUE | |||
) |
red | The red value. | |
green | The green value. | |
blue | The blue value. | |
alpha | The alpha value. Alpha values range from 0 (wxALPHA_TRANSPARENT) to 255 (wxALPHA_OPAQUE). |
wxColour::wxColour | ( | const wxString & | colourName | ) |
colourName | The colour name. |
wxColour::wxColour | ( | const wxColour & | colour | ) |
Copy constructor.
virtual unsigned char wxColour::Alpha | ( | ) | const [virtual] |
Returns the alpha value, on platforms where alpha is not yet supported, this always returns wxALPHA_OPAQUE.
virtual unsigned char wxColour::Blue | ( | ) | const [virtual] |
Returns the blue intensity.
virtual wxString wxColour::GetAsString | ( | long | flags = wxC2S_NAME|wxC2S_CSS_SYNTAX |
) | const [virtual] |
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.
int wxColour::GetPixel | ( | ) | const |
Returns a pixel value which is platform-dependent.
On Windows, a COLORREF is returned. On X, an allocated pixel value is returned. If the pixel is invalid (on X, unallocated), -1
is returned.
virtual unsigned char wxColour::Green | ( | ) | const [virtual] |
Returns the green intensity.
virtual bool wxColour::IsOk | ( | ) | const [virtual] |
Returns true if the colour object is valid (the colour has been initialised with RGB values).
bool wxColour::operator!= | ( | const wxColour & | colour | ) | const |
Tests the inequality of two colours by comparing individual red, green, blue colours and alpha values.
Assignment operator, using a colour name to be found in the colour database.
bool wxColour::operator== | ( | const wxColour & | colour | ) | const |
Tests the equality of two colours by comparing individual red, green, blue colours and alpha values.
virtual unsigned char wxColour::Red | ( | ) | const [virtual] |
Returns the red intensity.
bool wxColour::Set | ( | const wxString & | str | ) |
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).
When using third form, Set() accepts: colour names (those listed in wxTheColourDatabase()), the CSS-like "rgb(r,g,b)"
or "rgba(r,g,b,a)"
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.
void wxColour::Set | ( | unsigned long | RGB | ) |
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).
When using third form, Set() accepts: colour names (those listed in wxTheColourDatabase()), the CSS-like "rgb(r,g,b)"
or "rgba(r,g,b,a)"
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.
void wxColour::Set | ( | unsigned char | red, | |
unsigned char | green, | |||
unsigned char | blue, | |||
unsigned char | alpha = wxALPHA_OPAQUE | |||
) |
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).
When using third form, Set() accepts: colour names (those listed in wxTheColourDatabase()), the CSS-like "rgb(r,g,b)"
or "rgba(r,g,b,a)"
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.
![]() |
[ top ] |