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

NAME

6       wxColourPickerCtrl - Functions for wxColourPickerCtrl class
7

DESCRIPTION

9       This  control allows the user to select a colour. The generic implemen‐
10       tation is a button which brings up a wxColourDialog when  clicked.  Na‐
11       tive  implementation  may  differ  but this is usually a (small) widget
12       which give access to the colour-chooser dialog. It is only available if
13       wxUSE_COLOURPICKERCTRL is set to 1 (the default).
14
15       Styles
16
17       This class supports the following styles:
18
19       See: wxColourDialog, wxColourPickerEvent
20
21       This class is derived (and can use functions) from: wxPickerBase wxCon‐
22       trol wxWindow wxEvtHandler
23
24       wxWidgets docs: wxColourPickerCtrl
25

EVENTS

27       Event types emitted from this class: command_colourpicker_changed
28

DATA TYPES

30       wxColourPickerCtrl() = wx:wx_object()
31

EXPORTS

33       new() -> wxColourPickerCtrl()
34
35       new(Parent, Id) -> wxColourPickerCtrl()
36
37              Types:
38
39                 Parent = wxWindow:wxWindow()
40                 Id = integer()
41
42       new(Parent, Id, Options :: [Option]) -> wxColourPickerCtrl()
43
44              Types:
45
46                 Parent = wxWindow:wxWindow()
47                 Id = integer()
48                 Option =
49                     {col, wx:wx_colour()} |
50                     {pos, {X :: integer(), Y :: integer()}} |
51                     {size, {W :: integer(), H :: integer()}} |
52                     {style, integer()} |
53                     {validator, wx:wx_object()}
54
55              Initializes the object and calls create/4 with all  the  parame‐
56              ters.
57
58       create(This, Parent, Id) -> boolean()
59
60              Types:
61
62                 This = wxColourPickerCtrl()
63                 Parent = wxWindow:wxWindow()
64                 Id = integer()
65
66       create(This, Parent, Id, Options :: [Option]) -> boolean()
67
68              Types:
69
70                 This = wxColourPickerCtrl()
71                 Parent = wxWindow:wxWindow()
72                 Id = integer()
73                 Option =
74                     {col, wx:wx_colour()} |
75                     {pos, {X :: integer(), Y :: integer()}} |
76                     {size, {W :: integer(), H :: integer()}} |
77                     {style, integer()} |
78                     {validator, wx:wx_object()}
79
80              Creates a colour picker with the given arguments.
81
82              Return: true if the control was successfully created or false if
83              creation failed.
84
85       getColour(This) -> wx:wx_colour4()
86
87              Types:
88
89                 This = wxColourPickerCtrl()
90
91              Returns the currently selected colour.
92
93       setColour(This, Colname) -> ok
94
95       setColour(This, Col) -> ok
96
97              Types:
98
99                 This = wxColourPickerCtrl()
100                 Col = wx:wx_colour()
101
102              Sets the currently selected colour.
103
104              See wxColour::Set() (not implemented in wx).
105
106       destroy(This :: wxColourPickerCtrl()) -> ok
107
108              Destroys the object.
109
110
111
112wxWidgets team.                     wx 2.1               wxColourPickerCtrl(3)