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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
.. 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.RearrangeList:
==========================================================================================================================================
|phoenix_title| **wx.RearrangeList**
==========================================================================================================================================
A listbox-like control allowing the user to rearrange the items and to enable or disable them.
This class allows to change the order of the items shown in it as well as to check or uncheck them individually. The data structure used to allow this is the order array which contains the items indices indexed by their position with an added twist that the unchecked items are represented by the bitwise complement of the corresponding index (for any architecture using two's complement for negative numbers representation (i.e. just about any at all) this means that a checked item N is represented by ``-N-1`` in unchecked state). In practice this means that you must apply the C bitwise complement operator when constructing the order array, e.g. ::
order = [0] # checked item #0
So, for example, the array order ``[1`` -3 ``0]`` used in conjunction with the items array ["first", "second", "third"] means that the items order is "second", "third", "first" and the "third" item is unchecked while the other two are checked.
This convention is used both for the order argument of the control constructor or :meth:`~wx.RearrangeList.Create` and for the array returned from :meth:`~wx.RearrangeList.GetCurrentOrder`.
Usually this control will be used together with other controls allowing to move the items around in it interactively. The simplest possible solution is to use :ref:`wx.RearrangeCtrl` which combines it with two standard buttons to move the current item up or down.
.. 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>RearrangeList</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.RearrangeList_inheritance.png" alt="Inheritance diagram of RearrangeList" 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.Control.html" title="wx.Control" alt="" coords="224,237,312,267"/> <area shape="rect" id="node8" href="wx.ListBox.html" title="wx.ListBox" alt="" coords="152,315,240,344"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="233,160,321,189"/> <area shape="rect" id="node3" href="wx.ItemContainer.html" title="wx.ItemContainer" alt="" coords="57,237,191,267"/> <area shape="rect" id="node4" href="wx.ItemContainerImmutable.html" title="wx.ItemContainerImmutable" alt="" coords="5,160,208,189"/> <area shape="rect" id="node5" href="wx.Object.html" title="wx.Object" alt="" coords="179,5,260,35"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="221,83,332,112"/> <area shape="rect" id="node7" href="wx.CheckListBox.html" title="wx.CheckListBox" alt="" coords="133,392,259,421"/> <area shape="rect" id="node10" href="wx.RearrangeList.html" title="wx.RearrangeList" alt="" coords="131,469,260,499"/> <area shape="rect" id="node9" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="285,5,387,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.RearrangeList.__init__` Default constructor.
:meth:`~wx.RearrangeList.CanMoveCurrentDown` Return ``True`` if the currently selected item can be moved down.
:meth:`~wx.RearrangeList.CanMoveCurrentUp` Return ``True`` if the currently selected item can be moved up.
:meth:`~wx.RearrangeList.Create` Effectively creates the window for an object created using the default constructor.
:meth:`~wx.RearrangeList.GetCurrentOrder` Return the current order of the items.
:meth:`~wx.RearrangeList.MoveCurrentDown` Move the currently selected item one position below.
:meth:`~wx.RearrangeList.MoveCurrentUp` Move the currently selected item one position above.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.RearrangeList.CurrentOrder` See :meth:`~wx.RearrangeList.GetCurrentOrder`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.RearrangeList(CheckListBox)
**Possible constructors**::
RearrangeList()
RearrangeList(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
order=[], items=[], style=0, validator=DefaultValidator,
name=RearrangeListNameStr)
A listbox-like control allowing the user to rearrange the items and to
enable or disable them.
.. 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, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr)`
Constructor really creating the control.
Please see :meth:`Create` for the parameters description.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `order`:
:type `order`: list of integers
:param `items`:
:type `items`: list of strings
:param `style`:
:type `style`: long
:param `validator`:
:type `validator`: wx.Validator
:param `name`:
:type `name`: string
**~~~**
.. method:: CanMoveCurrentDown(self)
Return ``True`` if the currently selected item can be moved down.
:rtype: `bool`
.. seealso:: :meth:`CanMoveCurrentUp`
.. method:: CanMoveCurrentUp(self)
Return ``True`` if the currently selected item can be moved up.
This function is useful for ``EVT_UPDATE_UI`` handler for the standard "Up" button often used together with this control and :ref:`wx.RearrangeCtrl` uses it in this way.
:rtype: `bool`
:returns:
``True`` if the currently selected item can be moved up in the listbox, ``False`` if there is no selection or the current item is the first one.
.. seealso:: :meth:`CanMoveCurrentDown`
.. method:: Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, order=[], items=[], style=0, validator=DefaultValidator, name=RearrangeListNameStr)
Effectively creates the window for an object created using the default constructor.
This function is very similar to :meth:`wx.CheckListBox.Create` except that it has an additional parameter specifying the initial order of the items. Please see the class documentation for the explanation of the conventions used by the `order` argument.
:param `parent`: The parent window, must be non-NULL.
:type `parent`: wx.Window
:param `id`: The window identifier.
:type `id`: wx.WindowID
:param `pos`: The initial window position.
:type `pos`: wx.Point
:param `size`: The initial window size.
:type `size`: wx.Size
:param `order`: Array specifying the initial order of the items in `items` array.
:type `order`: list of integers
:param `items`: The items to display in the list.
:type `items`: list of strings
:param `style`: The control style, there are no special styles for this class but the base class styles can be used here.
:type `style`: long
:param `validator`: Optional window validator.
:type `validator`: wx.Validator
:param `name`: Optional window name.
:type `name`: string
:rtype: `bool`
.. method:: GetCurrentOrder(self)
Return the current order of the items.
The order may be different from the one passed to the constructor if :meth:`MoveCurrentUp` or :meth:`MoveCurrentDown` were called.
:rtype: `list of integers`
.. method:: MoveCurrentDown(self)
Move the currently selected item one position below.
:rtype: `bool`
.. seealso:: :meth:`MoveCurrentUp`
.. method:: MoveCurrentUp(self)
Move the currently selected item one position above.
This method is useful to implement the standard "Up" button behaviour and :ref:`wx.RearrangeCtrl` uses it for this.
:rtype: `bool`
:returns:
``True`` if the item was moved or ``False`` if this couldn't be done.
.. seealso:: :meth:`MoveCurrentDown`
.. attribute:: CurrentOrder
See :meth:`~wx.RearrangeList.GetCurrentOrder`
|
