wxColourData (wx v2.5.4)

Copy Markdown View Source

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

See:

wxWidgets docs: wxColourData

Summary

Functions

Destroys the object

Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls.

Gets the current colour associated with the colour dialog.

Returns custom colours associated with the colour dialog.

Constructor.

Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls.

Sets the default colour for the colour dialog.

Sets custom colours for the colour dialog.

Types

wxColourData()

-type wxColourData() :: wx:wx_object().

Functions

destroy(This :: wxColourData()) -> ok

Destroys the object

getChooseFull(This :: wxColourData()) -> boolean()

Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls.

Has no meaning under other platforms.

The default value is true.

getColour(This :: wxColourData()) -> wx:wx_colour4()

Gets the current colour associated with the colour dialog.

The default colour is black.

getCustomColour(This :: wxColourData(), I :: integer()) -> wx:wx_colour4()

Returns custom colours associated with the colour dialog.

new() -> wxColourData()

Constructor.

Initializes the custom colours to wxNullColour, the data colour setting to black, and the choose full setting to true.

setChooseFull(This :: wxColourData(), Flag :: boolean()) -> ok

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.

setColour(This :: wxColourData(), Colour :: wx:wx_colour()) -> ok

Sets the default colour for the colour dialog.

The default colour is black.

setCustomColour(This, I, Colour) -> ok

Types

This = wxColourData()
I = integer()
Colour = wx:wx_colour()

Sets custom colours for the colour dialog.