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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.ribbon.RibbonButtonBarEvent:
==========================================================================================================================================
|phoenix_title| **wx.ribbon.RibbonButtonBarEvent**
==========================================================================================================================================
Event used to indicate various actions relating to a button on a :ref:`wx.ribbon.RibbonButtonBar`.
For toggle buttons, :meth:`~wx.ribbon.RibbonButtonBarEvent.IsChecked` can be used to test the state of the button.
See :ref:`wx.ribbon.RibbonButtonBar` for available event types.
.. seealso:: :ref:`wx.ribbon.RibbonBar`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>RibbonButtonBarEvent</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.ribbon.RibbonButtonBarEvent_inheritance.png" alt="Inheritance diagram of RibbonButtonBarEvent" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Event.html" title="wx.Event" alt="" coords="81,83,159,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="47,160,192,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="79,5,160,35"/> <area shape="rect" id="node4" href="wx.ribbon.RibbonButtonBarEvent.html" title="wx.ribbon.RibbonButtonBarEvent" alt="" coords="5,237,235,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ribbon.RibbonButtonBarEvent.__init__` Constructor.
:meth:`~wx.ribbon.RibbonButtonBarEvent.GetBar` Returns the bar which contains the button which the event relates to.
:meth:`~wx.ribbon.RibbonButtonBarEvent.GetButton` Returns the button which the event relates to.
:meth:`~wx.ribbon.RibbonButtonBarEvent.PopupMenu` Display a popup menu as a result of this (dropdown clicked) event.
:meth:`~wx.ribbon.RibbonButtonBarEvent.SetBar` Sets the button bar relating to this event.
:meth:`~wx.ribbon.RibbonButtonBarEvent.SetButton` Sets the button relating to this event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ribbon.RibbonButtonBarEvent.Bar` See :meth:`~wx.ribbon.RibbonButtonBarEvent.GetBar` and :meth:`~wx.ribbon.RibbonButtonBarEvent.SetBar`
:attr:`~wx.ribbon.RibbonButtonBarEvent.Button` See :meth:`~wx.ribbon.RibbonButtonBarEvent.GetButton` and :meth:`~wx.ribbon.RibbonButtonBarEvent.SetButton`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ribbon.RibbonButtonBarEvent(CommandEvent)
**Possible constructors**::
RibbonButtonBarEvent(command_type=wxEVT_NULL, win_id=0, bar=None,
button=None)
Event used to indicate various actions relating to a button on a
RibbonButtonBar.
.. method:: __init__(self, command_type=wxEVT_NULL, win_id=0, bar=None, button=None)
Constructor.
:param `command_type`:
:type `command_type`: wx.EventType
:param `win_id`:
:type `win_id`: int
:param `bar`:
:type `bar`: wx.ribbon.RibbonButtonBar
:param `button`:
:type `button`: RibbonButtonBarButtonBase
.. method:: GetBar(self)
Returns the bar which contains the button which the event relates to.
:rtype: :ref:`wx.ribbon.RibbonButtonBar`
.. method:: GetButton(self)
Returns the button which the event relates to.
:rtype: :ref:`RibbonButtonBarButtonBase`
.. versionadded:: 2.9.5
.. method:: PopupMenu(self, menu)
Display a popup menu as a result of this (dropdown clicked) event.
:param `menu`:
:type `menu`: wx.Menu
:rtype: `bool`
.. method:: SetBar(self, bar)
Sets the button bar relating to this event.
:param `bar`:
:type `bar`: wx.ribbon.RibbonButtonBar
.. method:: SetButton(self, bar)
Sets the button relating to this event.
:param `bar`:
:type `bar`: RibbonButtonBarButtonBase
.. versionadded:: 2.9.5
.. attribute:: Bar
See :meth:`~wx.ribbon.RibbonButtonBarEvent.GetBar` and :meth:`~wx.ribbon.RibbonButtonBarEvent.SetBar`
.. attribute:: Button
See :meth:`~wx.ribbon.RibbonButtonBarEvent.GetButton` and :meth:`~wx.ribbon.RibbonButtonBarEvent.SetButton`
|
