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

NAME

6       wxRadioButton - Functions for wxRadioButton class
7

DESCRIPTION

9       A  radio  button  item is a button which usually denotes one of several
10       mutually exclusive options. It has a text label  next  to  a  (usually)
11       round button.
12
13       You  can create a group of mutually-exclusive radio buttons by specify‐
14       ing wxRB_GROUP for the first in the group. The group ends when  another
15       radio button group is created, or there are no more radio buttons.
16
17       Styles
18
19       This class supports the following styles:
20
21       See: Overview events, wxRadioBox, wxCheckBox
22
23       This  class is derived (and can use functions) from: wxControl wxWindow
24       wxEvtHandler
25
26       wxWidgets docs: wxRadioButton
27

EVENTS

29       Event types emitted from this class: command_radiobutton_selected
30

DATA TYPES

32       wxRadioButton() = wx:wx_object()
33

EXPORTS

35       new() -> wxRadioButton()
36
37              Default constructor.
38
39              See: create/5, wxValidator (not implemented in wx)
40
41       new(Parent, Id, Label) -> wxRadioButton()
42
43              Types:
44
45                 Parent = wxWindow:wxWindow()
46                 Id = integer()
47                 Label = unicode:chardata()
48
49       new(Parent, Id, Label, Options :: [Option]) -> wxRadioButton()
50
51              Types:
52
53                 Parent = wxWindow:wxWindow()
54                 Id = integer()
55                 Label = unicode:chardata()
56                 Option =
57                     {pos, {X :: integer(), Y :: integer()}} |
58                     {size, {W :: integer(), H :: integer()}} |
59                     {style, integer()} |
60                     {validator, wx:wx_object()}
61
62              Constructor, creating and showing a radio button.
63
64              See: create/5, wxValidator (not implemented in wx)
65
66       destroy(This :: wxRadioButton()) -> ok
67
68              Destructor, destroying the radio button item.
69
70       create(This, Parent, Id, Label) -> boolean()
71
72              Types:
73
74                 This = wxRadioButton()
75                 Parent = wxWindow:wxWindow()
76                 Id = integer()
77                 Label = unicode:chardata()
78
79       create(This, Parent, Id, Label, Options :: [Option]) -> boolean()
80
81              Types:
82
83                 This = wxRadioButton()
84                 Parent = wxWindow:wxWindow()
85                 Id = integer()
86                 Label = unicode:chardata()
87                 Option =
88                     {pos, {X :: integer(), Y :: integer()}} |
89                     {size, {W :: integer(), H :: integer()}} |
90                     {style, integer()} |
91                     {validator, wx:wx_object()}
92
93              Creates the choice for two-step construction.
94
95              See new/4 for further details.
96
97       getValue(This) -> boolean()
98
99              Types:
100
101                 This = wxRadioButton()
102
103              Returns true if the radio button is checked, false otherwise.
104
105       setValue(This, Value) -> ok
106
107              Types:
108
109                 This = wxRadioButton()
110                 Value = boolean()
111
112              Sets the radio button to checked or unchecked status.
113
114              This does not cause a wxEVT_RADIOBUTTON event to get emitted.
115
116              If the radio button belongs to a radio group exactly one  button
117              in  the  group  may  be  checked  and so this method can be only
118              called with value set to true. To uncheck a radio  button  in  a
119              group you must check another button in the same group.
120
121              Note:  Under  MSW,  the focused radio button is always selected,
122              i.e. its value is true. And, conversely, calling  SetValue(true)
123              will  also set focus to the radio button if the focus had previ‐
124              ously been on another radio button in the same group - as other‐
125              wise setting it on wouldn't work.
126
127
128
129wxWidgets team.                     wx 2.1                    wxRadioButton(3)