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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
.. 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.propgrid.PGMultiButton:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.PGMultiButton**
==========================================================================================================================================
This class can be used to have multiple buttons in a property editor.
You will need to create a new property editor class, override CreateControls, and have it return :ref:`wx.propgrid.PGMultiButton` instance in :meth:`wx.propgrid.PGWindowList.SetSecondary` .
For instance, here we add three buttons to a TextCtrl editor:
::
class SampleMultiButtonEditor(wx.propgrid.PGTextCtrlEditor):
def GetName(self):
return "SampleMultiButtonEditor"
def CreateControls(self, propGrid, aProperty, pos, size):
# Create and populate buttons-subwindow
buttons = wx.propgrid.PGMultiButton(propGrid, size)
# Add two regular buttons
buttons.Add("...")
buttons.Add("A")
# Add a bitmap button
buttons.Add(wx.ArtProvider.GetBitmap(wx.ART_FOLDER))
# Create the 'primary' editor control (textctrl in self case)
wndList = wx.propgrid.PGTextCtrlEditor.CreateControls(
propGrid, aProperty, pos, buttons.GetPrimarySize())
# Finally, move buttons-subwindow to correct position and make sure
# returned wx.propgrid.PGWindowList contains our custom button list.
buttons.Finalize(propGrid, pos)
wndList.SetSecondary(buttons)
return wndList
def OnEvent(self, propGrid, aProperty, ctrl, event):
if event.GetEventType() == wx.wxEVT_BUTTON:
buttons = propGrid.GetEditorControlSecondary()
if event.GetId() == buttons.GetButtonId(0):
# Do something when the first button is pressed
# Return true if the action modified the value in editor.
...
if event.GetId() == buttons.GetButtonId(1):
# Do something when the second button is pressed
...
if event.GetId() == buttons.GetButtonId(2):
# Do something when the third button is pressed
...
return wx.propgrid.PGTextCtrlEditor.OnEvent(propGrid, aProperty, ctrl, event)
Further to use this editor, code like this can be used:
::
# Register editor class - needs only to be called once
multiButtonEditor = SampleMultiButtonEditor()
wx.propgrid.PropertyGrid.RegisterEditorClass(multiButtonEditor)
# Insert the property that will have multiple buttons
propGrid.Append(
wx.propgrid.LongStringProperty("MultipleButtons", wx.propgrid.PG_LABEL))
# Change property to use editor created in the previous code segment
propGrid.SetPropertyEditor("MultipleButtons", multiButtonEditor)
|
|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>PGMultiButton</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.propgrid.PGMultiButton_inheritance.png" alt="Inheritance diagram of PGMultiButton" 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.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.propgrid.PGMultiButton.html" title="wx.propgrid.PGMultiButton" alt="" coords="9,237,199,267"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.PGMultiButton.__init__` Constructor.
:meth:`~wx.propgrid.PGMultiButton.Add` Adds new button, with given label.
:meth:`~wx.propgrid.PGMultiButton.AddBitmapButton` A simple wrapper around the PGMultiButton.Add method, for backwards compatibility.
:meth:`~wx.propgrid.PGMultiButton.AddButton` A simple wrapper around the PGMultiButton.Add method, for backwards compatibility.
:meth:`~wx.propgrid.PGMultiButton.Finalize` Call this in CreateControls() of your custom editor class after all buttons have been added.
:meth:`~wx.propgrid.PGMultiButton.GetButton` Returns pointer to one of the buttons.
:meth:`~wx.propgrid.PGMultiButton.GetButtonId` Returns Id of one of the buttons.
:meth:`~wx.propgrid.PGMultiButton.GetCount` Returns number of buttons.
:meth:`~wx.propgrid.PGMultiButton.GetPrimarySize` Returns size of primary editor control, as appropriately reduced by number of buttons present.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.propgrid.PGMultiButton.Count` See :meth:`~wx.propgrid.PGMultiButton.GetCount`
:attr:`~wx.propgrid.PGMultiButton.PrimarySize` See :meth:`~wx.propgrid.PGMultiButton.GetPrimarySize`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.PGMultiButton(Window)
**Possible constructors**::
PGMultiButton(pg, sz)
This class can be used to have multiple buttons in a property editor.
.. method:: __init__(self, pg, sz)
Constructor.
:param `pg`:
:type `pg`: wx.propgrid.PropertyGrid
:param `sz`:
:type `sz`: wx.Size
.. method:: Add(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**Add** `(self, label, id=-2)`
Adds new button, with given label.
:param `label`:
:type `label`: string
:param `id`:
:type `id`: int
**~~~**
**Add** `(self, bitmap, id=-2)`
Adds new bitmap button.
:param `bitmap`:
:type `bitmap`: wx.Bitmap
:param `id`:
:type `id`: int
**~~~**
.. method:: AddBitmapButton(self, bitmap, id=-2)
A simple wrapper around the PGMultiButton.Add method, for backwards compatibility.
.. method:: AddButton(self, label, id=-2)
A simple wrapper around the PGMultiButton.Add method, for backwards compatibility.
.. method:: Finalize(self, propGrid, pos)
Call this in CreateControls() of your custom editor class after all buttons have been added.
:param `propGrid`: :ref:`wx.propgrid.PropertyGrid` given in CreateControls().
:type `propGrid`: wx.propgrid.PropertyGrid
:param `pos`: :ref:`wx.Point` given in CreateControls().
:type `pos`: wx.Point
.. method:: GetButton(self, i)
Returns pointer to one of the buttons.
:param `i`:
:type `i`: int
:rtype: :ref:`Window`
.. method:: GetButtonId(self, i)
Returns Id of one of the buttons.
This is utility function to be used in event handlers.
:param `i`:
:type `i`: int
:rtype: `int`
.. method:: GetCount(self)
Returns number of buttons.
:rtype: `int`
.. method:: GetPrimarySize(self)
Returns size of primary editor control, as appropriately reduced by number of buttons present.
:rtype: :ref:`Size`
.. attribute:: Count
See :meth:`~wx.propgrid.PGMultiButton.GetCount`
.. attribute:: PrimarySize
See :meth:`~wx.propgrid.PGMultiButton.GetPrimarySize`
|
