1wxColourData(3)            Erlang Module Definition            wxColourData(3)
2
3
4

NAME

6       wxColourData - Functions for wxColourData class
7

DESCRIPTION

9       This class holds a variety of information related to colour dialogs.
10
11       See: wx_color(), wxColourDialog, Overview cmndlg
12
13       wxWidgets docs: wxColourData
14

DATA TYPES

16       wxColourData() = wx:wx_object()
17

EXPORTS

19       new() -> wxColourData()
20
21              Constructor.
22
23              Initializes  the custom colours to wxNullColour, the data colour
24              setting to black, and the choose full setting to true.
25
26       destroy(This :: wxColourData()) -> ok
27
28              Destructor.
29
30       getChooseFull(This) -> boolean()
31
32              Types:
33
34                 This = wxColourData()
35
36              Under Windows, determines whether the Windows colour dialog will
37              display the full dialog with custom colour selection controls.
38
39              Has no meaning under other platforms.
40
41              The default value is true.
42
43       getColour(This) -> wx:wx_colour4()
44
45              Types:
46
47                 This = wxColourData()
48
49              Gets the current colour associated with the colour dialog.
50
51              The default colour is black.
52
53       getCustomColour(This, I) -> wx:wx_colour4()
54
55              Types:
56
57                 This = wxColourData()
58                 I = integer()
59
60              Returns custom colours associated with the colour dialog.
61
62       setChooseFull(This, Flag) -> ok
63
64              Types:
65
66                 This = wxColourData()
67                 Flag = boolean()
68
69              Under  Windows,  tells  the Windows colour dialog to display the
70              full dialog with custom colour selection controls.
71
72              Under other platforms, has no effect.
73
74              The default value is true.
75
76       setColour(This, Colour) -> ok
77
78              Types:
79
80                 This = wxColourData()
81                 Colour = wx:wx_colour()
82
83              Sets the default colour for the colour dialog.
84
85              The default colour is black.
86
87       setCustomColour(This, I, Colour) -> ok
88
89              Types:
90
91                 This = wxColourData()
92                 I = integer()
93                 Colour = wx:wx_colour()
94
95              Sets custom colours for the colour dialog.
96
97
98
99wxWidgets team.                     wx 2.1                     wxColourData(3)