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

NAME

6       wxCheckBox - Functions for wxCheckBox class
7

DESCRIPTION

9       A  checkbox  is a labelled box which by default is either on (checkmark
10       is visible) or off (no checkmark). Optionally  (when  the  wxCHK_3STATE
11       style flag is set) it can have a third state, called the mixed or unde‐
12       termined state. Often this is used as a "Does Not Apply" state.
13
14       Styles
15
16       This class supports the following styles:
17
18       See: wxRadioButton, wxCommandEvent
19
20       This class is derived (and can use functions) from: wxControl  wxWindow
21       wxEvtHandler
22
23       wxWidgets docs: wxCheckBox
24

EVENTS

26       Event types emitted from this class: command_checkbox_clicked
27

DATA TYPES

29       wxCheckBox() = wx:wx_object()
30

EXPORTS

32       new() -> wxCheckBox()
33
34              Default constructor.
35
36              See: create/5, wxValidator (not implemented in wx)
37
38       new(Parent, Id, Label) -> wxCheckBox()
39
40              Types:
41
42                 Parent = wxWindow:wxWindow()
43                 Id = integer()
44                 Label = unicode:chardata()
45
46       new(Parent, Id, Label, Options :: [Option]) -> wxCheckBox()
47
48              Types:
49
50                 Parent = wxWindow:wxWindow()
51                 Id = integer()
52                 Label = unicode:chardata()
53                 Option =
54                     {pos, {X :: integer(), Y :: integer()}} |
55                     {size, {W :: integer(), H :: integer()}} |
56                     {style, integer()} |
57                     {validator, wx:wx_object()}
58
59              Constructor, creating and showing a checkbox.
60
61              See: create/5, wxValidator (not implemented in wx)
62
63       destroy(This :: wxCheckBox()) -> ok
64
65              Destructor, destroying the checkbox.
66
67       create(This, Parent, Id, Label) -> boolean()
68
69              Types:
70
71                 This = wxCheckBox()
72                 Parent = wxWindow:wxWindow()
73                 Id = integer()
74                 Label = unicode:chardata()
75
76       create(This, Parent, Id, Label, Options :: [Option]) -> boolean()
77
78              Types:
79
80                 This = wxCheckBox()
81                 Parent = wxWindow:wxWindow()
82                 Id = integer()
83                 Label = unicode:chardata()
84                 Option =
85                     {pos, {X :: integer(), Y :: integer()}} |
86                     {size, {W :: integer(), H :: integer()}} |
87                     {style, integer()} |
88                     {validator, wx:wx_object()}
89
90              Creates the checkbox for two-step construction.
91
92              See new/4 for details.
93
94       getValue(This) -> boolean()
95
96              Types:
97
98                 This = wxCheckBox()
99
100              Gets the state of a 2-state checkbox.
101
102              Return: Returns true if it is checked, false otherwise.
103
104       get3StateValue(This) -> wx:wx_enum()
105
106              Types:
107
108                 This = wxCheckBox()
109
110              Gets the state of a 3-state checkbox.
111
112              Asserts when the function is used with a 2-state checkbox.
113
114       is3rdStateAllowedForUser(This) -> boolean()
115
116              Types:
117
118                 This = wxCheckBox()
119
120              Returns  whether  or  not  the  user can set the checkbox to the
121              third state.
122
123              Return: true if the user can set the third state of this  check‐
124              box,  false  if it can only be set programmatically or if it's a
125              2-state checkbox.
126
127       is3State(This) -> boolean()
128
129              Types:
130
131                 This = wxCheckBox()
132
133              Returns whether or not the checkbox is a 3-state checkbox.
134
135              Return: true if this checkbox is a 3-state  checkbox,  false  if
136              it's a 2-state checkbox.
137
138       isChecked(This) -> boolean()
139
140              Types:
141
142                 This = wxCheckBox()
143
144              This  is just a maybe more readable synonym for getValue/1: just
145              as the latter, it returns true if the checkbox  is  checked  and
146              false otherwise.
147
148       setValue(This, State) -> ok
149
150              Types:
151
152                 This = wxCheckBox()
153                 State = boolean()
154
155              Sets the checkbox to the given state.
156
157              This does not cause a wxEVT_CHECKBOX event to get emitted.
158
159       set3StateValue(This, State) -> ok
160
161              Types:
162
163                 This = wxCheckBox()
164                 State = wx:wx_enum()
165
166              Sets the checkbox to the given state.
167
168              This does not cause a wxEVT_CHECKBOX event to get emitted.
169
170              Asserts  when the checkbox is a 2-state checkbox and setting the
171              state to wxCHK_UNDETERMINED.
172
173
174
175wxWidgets team.                     wx 2.1                       wxCheckBox(3)