wxColour

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

wxObject

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::GetPixel
wxColour::Green
wxColour::Ok
wxColour::Red
wxColour::Set
wxColour::operator =
wxColour::operator ==
wxColour::operator !=

wxColour::wxColour

wxColour()

Default constructor.

wxColour(const unsigned char red, const unsigned char green, const unsigned char blue)

Constructs a colour from red, green and blue values.

wxColour(const wxString& colourNname)

Constructs a colour object using a colour name listed in wxTheColourDatabase.

wxColour(const wxColour& colour)

Copy constructor.

Parameters

red

The red value.

green

The green value.

blue

The blue value.

colourName

The colour name.

colour

The colour to copy.

See also

wxColourDatabase

wxPython note: Constructors supported by wxPython are:

wxColour(red=0, green=0, blue=0)
wxNamedColour(name)

wxColour::Blue

unsigned char Blue() const

Returns the blue intensity.

wxColour::GetPixel

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).

wxColour::Green

unsigned char Green() const

Returns the green intensity.

wxColour::Ok

bool Ok() const

Returns true if the colour object is valid (the colour has been initialised with RGB values).

wxColour::Red

unsigned char Red() const

Returns the red intensity.

wxColour::Set

void Set(const unsigned char red, const unsigned char green, const unsigned char blue)

Sets the RGB intensity values.

wxColour::operator =

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

wxColourDatabase

wxColour::operator ==

bool operator ==(const wxColour& colour)

Tests the equality of two colours by comparing individual red, green blue colours.

wxColour::operator !=

bool operator !=(const wxColour& colour)

Tests the inequality of two colours by comparing individual red, green blue colours.