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
|
.. 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.RearrangeDialog:
==========================================================================================================================================
|phoenix_title| **wx.RearrangeDialog**
==========================================================================================================================================
A dialog allowing the user to rearrange the specified items.
This dialog can be used to allow the user to modify the order of the items and to enable or disable them individually. For example: ::
items = ["meat", "fish", "fruits", "beer"]
order = [3, 0, 1, 2]
dlg = wx.RearrangeDialog(None,
"You can also uncheck the items you don't like "
"at all.",
"Sort the items in order of preference",
order, items)
if dlg.ShowModal() == wx.ID_OK:
order = dlg.GetOrder()
for n in order:
if n >= 0:
wx.LogMessage("Your most preferred item is \"%s\""%n)
break
.. versionadded:: 2.9.0
|
|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>RearrangeDialog</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.RearrangeDialog_inheritance.png" alt="Inheritance diagram of RearrangeDialog" 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.Trackable.html" title="wx.Trackable" alt="" coords="5,5,107,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window" alt="" coords="69,160,157,189"/> <area shape="rect" id="node6" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="34,237,192,267"/> <area shape="rect" id="node5" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="42,315,184,344"/> <area shape="rect" id="node7" href="wx.Dialog.html" title="wx.Dialog" alt="" coords="72,392,153,421"/> <area shape="rect" id="node8" href="wx.RearrangeDialog.html" title="wx.RearrangeDialog" alt="" coords="40,469,187,499"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.RearrangeDialog.__init__` Default constructor.
:meth:`~wx.RearrangeDialog.AddExtraControls` Customize the dialog by adding extra controls to it.
:meth:`~wx.RearrangeDialog.Create` Effectively creates the dialog for an object created using the default constructor.
:meth:`~wx.RearrangeDialog.GetList` Return the list control used by the dialog.
:meth:`~wx.RearrangeDialog.GetOrder` Return the array describing the order of items after it was modified by the user.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.RearrangeDialog.List` See :meth:`~wx.RearrangeDialog.GetList`
:attr:`~wx.RearrangeDialog.Order` See :meth:`~wx.RearrangeDialog.GetOrder`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.RearrangeDialog(Dialog)
**Possible constructors**::
RearrangeDialog()
RearrangeDialog(parent, message, title=EmptyString, order=[], items=[],
pos=DefaultPosition, name=RearrangeDialogNameStr)
A dialog allowing the user to rearrange the specified items.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
:meth:`Create` must be called later to effectively create the control.
**~~~**
**__init__** `(self, parent, message, title=EmptyString, order=[], items=[], pos=DefaultPosition, name=RearrangeDialogNameStr)`
Constructor creating the dialog.
Please see :meth:`Create` for the parameters description.
:param `parent`:
:type `parent`: wx.Window
:param `message`:
:type `message`: string
:param `title`:
:type `title`: string
:param `order`:
:type `order`: list of integers
:param `items`:
:type `items`: list of strings
:param `pos`:
:type `pos`: wx.Point
:param `name`:
:type `name`: string
**~~~**
.. method:: AddExtraControls(self, win)
Customize the dialog by adding extra controls to it.
This function adds the given `win` to the dialog, putting it just below the part occupied by :ref:`wx.RearrangeCtrl`. It must be called after creating the dialog and you will typically need to process the events generated by the extra controls for them to do something useful.
For example: ::
class MyRearrangeDialog(wx.RearrangeDialog):
def __init__(self, parent):
wx.RearrangeDialog.__init__(self, parent)
panel = wx.Panel(self)
sizer = wx.BoxSizer(wx.HORIZONTAL)
sizer.Add(wx.StaticText(panel, wx.ID_ANY,
"Column width in pixels:"))
sizer.Add(wx.TextCtrl(panel, wx.ID_ANY, ""))
panel.SetSizer(sizer)
self.AddExtraControls(panel)
# ... code to update the text control with the currently selected
# item width and to react to its changes omitted ...
See also the complete example of a custom rearrange dialog in the dialogs sample.
:param `win`: The window containing the extra controls. It must have this dialog as its parent.
:type `win`: wx.Window
.. method:: Create(self, parent, message, title=EmptyString, order=[], items=[], pos=DefaultPosition, name=RearrangeDialogNameStr)
Effectively creates the dialog for an object created using the default constructor.
:param `parent`: The dialog parent, possibly ``None``.
:type `parent`: wx.Window
:param `message`: The message shown inside the dialog itself, above the items list.
:type `message`: string
:param `title`: The title of the dialog.
:type `title`: string
:param `order`: The initial order of the items in the convention used by :ref:`wx.RearrangeList`.
:type `order`: list of integers
:param `items`: The items to show in the dialog.
:type `items`: list of strings
:param `pos`: Optional dialog position.
:type `pos`: wx.Point
:param `name`: Optional dialog name.
:type `name`: string
:rtype: `bool`
:returns:
``True`` if the dialog was successfully created or ``False`` if creation failed.
.. method:: GetList(self)
Return the list control used by the dialog.
:rtype: :ref:`wx.RearrangeList`
.. seealso:: :meth:`wx.RearrangeCtrl.GetList`
.. method:: GetOrder(self)
Return the array describing the order of items after it was modified by the user.
Please notice that the array will contain negative items if any items were unchecked. See :ref:`wx.RearrangeList` for more information about the convention used for this array.
:rtype: `list of integers`
.. attribute:: List
See :meth:`~wx.RearrangeDialog.GetList`
.. attribute:: Order
See :meth:`~wx.RearrangeDialog.GetOrder`
|
