blob: 52c4daeb484ed9064d0eef106da517c22eb9484e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<!-- THIS FILE IS GENERATED DO NOT EDIT -->
<erlref>
<header>
<copyright>
<year>2020</year><year>2021</year>
<holder>wxWidgets team.</holder></copyright>
<legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
</legalnotice>
<title>wxToggleButton</title>
</header>
<module>wxToggleButton</module>
<modulesummary>Functions for wxToggleButton class</modulesummary>
<description><p><seeerl marker="wxToggleButton"><c>wxToggleButton</c></seeerl> is a button that stays pressed when clicked by the user. In other words, it is similar to <seeerl marker="wxCheckBox"><c>wxCheckBox</c></seeerl> in functionality but looks like a <seeerl marker="wxButton"><c>wxButton</c></seeerl>.
</p><p>Since wxWidgets version 2.9.0 this control emits an update UI event.
</p><p>You can see <seeerl marker="wxToggleButton"><c>wxToggleButton</c></seeerl> in action in page_samples_widgets.
</p><p>See: <seeerl marker="wxCheckBox"><c>wxCheckBox</c></seeerl>, <seeerl marker="wxButton"><c>wxButton</c></seeerl>, <c>wxBitmapToggleButton</c> (not implemented in wx)
</p>
<p>This class is derived (and can use functions) from:
<seeerl marker="wxControl"><c>wxControl</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
<p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_toggle_button.html">wxToggleButton</url></p>
</description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxCommandEvent"><c>command_togglebutton_clicked</c></seeerl></p></section>
<datatypes><datatype><name name="wxToggleButton"/></datatype></datatypes>
<funcs>
<func>
<name name="new" arity="0" clause_i="1" since=""/>
<fsummary>Default constructor. </fsummary>
<desc><p>Default constructor.
</p></desc>
</func>
<func>
<name name="new" arity="3" clause_i="1" since=""/>
<fsummary>See: <c>new/4</c></fsummary>
</func>
<func>
<name name="new" arity="4" clause_i="1" since=""/>
<fsummary>Constructor, creating and showing a toggle button. </fsummary>
<desc><p>Constructor, creating and showing a toggle button.
</p><p>See: <seemfa marker="#create/5"><c>create/5</c></seemfa>, <c>wxValidator</c> (not implemented in wx)
</p></desc>
</func>
<func>
<name name="destroy" arity="1" clause_i="1" since=""/>
<fsummary>Destructor, destroying the toggle button. </fsummary>
<desc><p>Destructor, destroying the toggle button.
</p></desc>
</func>
<func>
<name name="create" arity="4" clause_i="1" since=""/>
<fsummary>See: <c>create/5</c></fsummary>
</func>
<func>
<name name="create" arity="5" clause_i="1" since=""/>
<fsummary>Creates the toggle button for two-step construction. </fsummary>
<desc><p>Creates the toggle button for two-step construction.
</p><p>See <seemfa marker="#new/4"><c>new/4</c></seemfa> for details.
</p></desc>
</func>
<func>
<name name="getValue" arity="1" clause_i="1" since=""/>
<fsummary>Gets the state of the toggle button. </fsummary>
<desc><p>Gets the state of the toggle button.
</p><p>Return: Returns true if it is pressed, false otherwise.
</p></desc>
</func>
<func>
<name name="setValue" arity="2" clause_i="1" since=""/>
<fsummary>Sets the toggle button to the given state. </fsummary>
<desc><p>Sets the toggle button to the given state.
</p><p>This does not cause a <c>EVT_TOGGLEBUTTON</c> event to be emitted.
</p></desc>
</func>
</funcs>
</erlref>
|
