wxcolourdata

this class holds a variety of information related to colour dialogs.

derived from

wxobject

include files

<wx/cmndata.h>

see also

wxcolour, wxcolourdialog, wxcolourdialog overview

members

wxcolourdata::wxcolourdata
wxcolourdata::~wxcolourdata
wxcolourdata::getchoosefull
wxcolourdata::getcolour
wxcolourdata::getcustomcolour
wxcolourdata::setchoosefull
wxcolourdata::setcolour
wxcolourdata::setcustomcolour
wxcolourdata::operator =

wxcolourdata::wxcolourdata

wxcolourdata()

constructor. initializes the custom colours to wxnullcolour, the data colour setting to black, and the choose full setting to true.

wxcolourdata::~wxcolourdata

~wxcolourdata()

destructor.

wxcolourdata::getchoosefull

bool getchoosefull() const

under windows, determines whether the windows colour dialog will display the full dialog with custom colour selection controls. under palmos, determines whether colour dialog will display full rgb colour picker or only available palette indexer. has no meaning under other platforms.

the default value is true.

wxcolourdata::getcolour

wxcolour& getcolour() const

gets the current colour associated with the colour dialog.

the default colour is black.

wxcolourdata::getcustomcolour

wxcolour& getcustomcolour(int i) const

gets the ith custom colour associated with the colour dialog. i should be an integer between 0 and 15.

the default custom colours are invalid colours.

wxcolourdata::setchoosefull

void setchoosefull(const bool flag)

under windows, tells the windows colour dialog to display the full dialog with custom colour selection controls. under other platforms, has no effect.

the default value is true.

wxcolourdata::setcolour

void setcolour(const wxcolour& colour)

sets the default colour for the colour dialog.

the default colour is black.

wxcolourdata::setcustomcolour

void setcustomcolour(int i, const wxcolour& colour)

sets the ith custom colour for the colour dialog. i should be an integer between 0 and 15.

the default custom colours are invalid colours.

wxcolourdata::operator =

void operator =(const wxcolourdata& data)

assignment operator for the colour data.