View Source wxColourData (wx v2.4.2)

Functions for wxColourData class

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

See: wx_color(), wxColourDialog, Overview cmndlg

wxWidgets docs: wxColourData

Summary

Functions

Destructor.

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

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

Functions

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

Destructor.

-spec getChooseFull(This) -> boolean() when This :: wxColourData().

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.

-spec getColour(This) -> wx:wx_colour4() when This :: wxColourData().

Gets the current colour associated with the colour dialog.

The default colour is black.

Link to this function

getCustomColour(This, I)

View Source
-spec getCustomColour(This, I) -> wx:wx_colour4() when This :: wxColourData(), I :: integer().

Returns custom colours associated with the colour dialog.

-spec new() -> wxColourData().

Constructor.

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

Link to this function

setChooseFull(This, Flag)

View Source
-spec setChooseFull(This, Flag) -> ok when This :: wxColourData(), Flag :: boolean().

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.

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

Sets the default colour for the colour dialog.

The default colour is black.

Link to this function

setCustomColour(This, I, Colour)

View Source
-spec setCustomColour(This, I, Colour) -> ok
                   when This :: wxColourData(), I :: integer(), Colour :: wx:wx_colour().

Sets custom colours for the colour dialog.