wx.ColourData

Inheritance diagram for wx.ColourData:

Description

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

See also

wx.Colour, wx.ColourDialog

Derived From

• wx.Object

Methods Summary

• __init__
• GetChooseFull
• GetColour
• GetCustomColour
• SetChooseFull
• SetColour
• SetCustomColour

Properties Summary

• ChooseFull
• Colour
• CustomColour

Class API

Methods

__init__()

Constructor, sets default values.

Returns:

wx.ColourData

---

GetChooseFull()

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.

Returns:

bool

---

GetColour()

Gets the current colour associated with the colour dialog.

The default colour is black.

Returns:

wx.Colour

---

GetCustomColour(i)

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

The default custom colours are invalid colours.

Parameters:

• i (int)

Returns:

wx.Colour

---

SetChooseFull(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.

Parameters:

• flag (bool)

---

SetColour(colour)

Sets the default colour for the colour dialog.

The default colour is black.

Parameters:

• colour (wx.Colour)

---

SetCustomColour(i, colour)

Sets the i th custom colour for the colour dialog. i should be an integer between 0 and 15.

The default custom colours are invalid colours.

Parameters:

• i (int)
• colour (wx.Colour)

---

Properties

ChooseFull

See GetChooseFull and SetChooseFull

Colour

See GetColour and SetColour

CustomColour

See GetCustomColour and SetCustomColour