---
name: "wxColourData"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:25.2.3+dfsg-1+deb12u4"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/wxColourData"
---

# wxColourData(3erl)

Functions for wxColourData class

## NAME

wxColourData - Functions for wxColourData class

## DESCRIPTION

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

See: *wx\_color()*, *wxColourDialog*, Overview cmndlg

wxWidgets docs: wxColourData

## DATA TYPES

```
wxColourData() = wx:wx_object()
```

## EXPORTS

```
new() -> wxColourData()
```

Constructor.

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

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

Destructor.

```
getChooseFull(This) -> boolean()
```

Types:

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.

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

Types:

This = wxColourData()\

Gets the current colour associated with the colour dialog.

The default colour is black.

```
getCustomColour(This, I) -> wx:wx_colour4()
```

Types:

This = wxColourData()\
 I = integer()\

Returns custom colours associated with the colour dialog.

```
setChooseFull(This, Flag) -> ok
```

Types:

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.

```
setColour(This, Colour) -> ok
```

Types:

This = wxColourData()\
 Colour = wx:wx\_colour()\

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.