wxRuby Documentation Home

# Wx::ColourData

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

## Derived from

Object

## See also

Colour, ColourDialog, ColourDialog overview

## Methods

- ColourData.new
- ColourData#get_choose_full
- ColourData#get_colour
- ColourData#get_custom_colour
- ColourData#set_choose_full
- ColourData#set_colour
- ColourData#set_custom_colour

### ColourData.new

destructor()

Destructor.

### ColourData#get_choose_full

Boolean get_choose_full()

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.

### ColourData#get_colour

Colour get_colour()

Gets the current colour associated with the colour dialog.

The default colour is black.

### ColourData#get_custom_colour

Colour get_custom_colour(%(arg-type)Integer% 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.

### ColourData#set_choose_full

set_choose_full(%(arg-type)Boolean% 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.

### ColourData#set_colour

set_colour(%(arg-type)Colour% colour)

Sets the default colour for the colour dialog.

The default colour is black.

### ColourData#set_custom_colour

set_custom_colour(%(arg-type)Integer% i, Colour 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.

### ColourData#=

operator $=$(%(arg-type)ColourData% data)

Assignment operator for the colour data.

[This page automatically generated from the Textile source at 2023-06-09 00:45:34 +0000]