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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
|
.. 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.Choice:
==========================================================================================================================================
|phoenix_title| **wx.Choice**
==========================================================================================================================================
A choice item is used to select one of a list of strings.
Unlike a :ref:`wx.ListBox`, only the selection is visible until the user pulls down the menu of choices.
.. _Choice-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.CB_SORT``: Sorts the entries alphabetically.
.. _Choice-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.CommandEvent` parameter.
- EVT_CHOICE: Process a ``wxEVT_CHOICE`` event, when an item on the list is selected.
.. seealso:: :ref:`wx.ListBox`, :ref:`wx.ComboBox`, :ref:`wx.CommandEvent`
|
|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>Choice</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.Choice_inheritance.png" alt="Inheritance diagram of Choice" 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.Choice.html" title="wx.Choice" alt="" coords="153,315,239,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.Trackable.html" title="wx.Trackable" alt="" coords="285,5,387,35"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.choice.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.choice.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.choice.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.DirFilterListCtrl`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Choice.__init__` Default constructor.
:meth:`~wx.Choice.Create` Creates the choice for two-step construction.
:meth:`~wx.Choice.FindString` Finds an item whose label matches the given string.
:meth:`~wx.Choice.GetColumns` Gets the number of columns in this choice item.
:meth:`~wx.Choice.GetCount` Returns the number of items in the control.
:meth:`~wx.Choice.GetCurrentSelection` Unlike :meth:`wx.ControlWithItems.GetSelection` which only returns the accepted selection value (the selection in the control once the user closes the dropdown list), this function returns the current selection.
:meth:`~wx.Choice.GetSelection` Returns the index of the selected item or ``NOT_FOUND`` if no item is selected.
:meth:`~wx.Choice.GetString` Returns the label of the item with the given index.
:meth:`~wx.Choice.IsSorted`
:meth:`~wx.Choice.SetColumns` Sets the number of columns in this choice item.
:meth:`~wx.Choice.SetSelection` Sets the selection to the given item `n` or removes the selection entirely if `n` == ``NOT_FOUND`` .
:meth:`~wx.Choice.SetString` Sets the label for the given item.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Choice.Columns` See :meth:`~wx.Choice.GetColumns` and :meth:`~wx.Choice.SetColumns`
:attr:`~wx.Choice.Count` See :meth:`~wx.Choice.GetCount`
:attr:`~wx.Choice.CurrentSelection` See :meth:`~wx.Choice.GetCurrentSelection`
:attr:`~wx.Choice.Selection` See :meth:`~wx.Choice.GetSelection` and :meth:`~wx.Choice.SetSelection`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Choice(Control, ItemContainer)
**Possible constructors**::
Choice()
Choice(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
choices=[], style=0, validator=DefaultValidator, name=ChoiceNameStr)
A choice item is used to select one of a list of strings.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
.. seealso:: :meth:`Create` , :ref:`wx.Validator`
**~~~**
**__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ChoiceNameStr)`
Constructor, creating and showing a choice.
:param `parent`: Parent window. Must not be ``None``.
:type `parent`: wx.Window
:param `id`: Window identifier. The value ``wx.ID_ANY`` indicates a default value.
:type `id`: wx.WindowID
:param `pos`: Window position.
:type `pos`: wx.Point
:param `size`: Window size. If DefaultSize is specified then the choice is sized appropriately.
:type `size`: wx.Size
:param `choices`: An array of strings with which to initialise the choice control.
:type `choices`: list of strings
:param `style`: Window style. See :ref:`wx.Choice`.
:type `style`: long
:param `validator`: Window validator.
:type `validator`: wx.Validator
:param `name`: Window name.
:type `name`: string
**~~~**
.. method:: Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ChoiceNameStr)
Creates the choice for two-step construction.
See :ref:`wx.Choice`.
: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 `choices`:
:type `choices`: list of strings
:param `style`:
:type `style`: long
:param `validator`:
:type `validator`: wx.Validator
:param `name`:
:type `name`: string
:rtype: `bool`
.. method:: FindString(self, string, caseSensitive=False)
Finds an item whose label matches the given string.
:param `string`: String to find.
:type `string`: string
:param `caseSensitive`: Whether search is case sensitive (default is not).
:type `caseSensitive`: bool
:rtype: `int`
:returns:
The zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not found.
.. method:: GetColumns(self)
Gets the number of columns in this choice item.
:rtype: `int`
.. note::
This is implemented for GTK and Motif only and always returns 1 for the other platforms.
.. method:: GetCount(self)
Returns the number of items in the control.
:rtype: `int`
.. seealso:: :meth:`IsEmpty`
.. method:: GetCurrentSelection(self)
Unlike :meth:`wx.ControlWithItems.GetSelection` which only returns the accepted selection value (the selection in the control once the user closes the dropdown list), this function returns the current selection.
That is, while the dropdown list is shown, it returns the currently selected item in it. When it is not shown, its result is the same as for the other function.
:rtype: `int`
.. versionadded:: 2.6.2.
In older versions, :meth:`wx.ControlWithItems.GetSelection` itself behaved like this.
.. method:: GetSelection(self)
Returns the index of the selected item or ``NOT_FOUND`` if no item is selected.
:rtype: `int`
:returns:
The position of the current selection.
.. note::
This method can be used with single selection list boxes only, you should use :meth:`wx.ListBox.GetSelections` for the list boxes with ``wx.LB_MULTIPLE`` style.
.. seealso:: :meth:`SetSelection` , :meth:`GetStringSelection`
.. method:: GetString(self, n)
Returns the label of the item with the given index.
:param `n`: The zero-based index.
:type `n`: int
:rtype: `string`
:returns:
The label of the item or an empty string if the position was invalid.
.. method:: IsSorted(self)
:rtype: `bool`
.. method:: SetColumns(self, n=1)
Sets the number of columns in this choice item.
:param `n`: Number of columns.
:type `n`: int
.. note::
This is implemented for GTK and Motif only and doesn’t do anything under other platforms.
.. method:: SetSelection(self, n)
Sets the selection to the given item `n` or removes the selection entirely if `n` == ``NOT_FOUND`` .
Note that this does not cause any command events to be emitted nor does it deselect any other items in the controls which support multiple selections.
:param `n`: The string position to select, starting from zero.
:type `n`: int
.. seealso:: :meth:`SetString` , :meth:`SetStringSelection`
.. method:: SetString(self, n, string)
Sets the label for the given item.
:param `n`: The zero-based item index.
:type `n`: int
:param `string`: The label to set.
:type `string`: string
.. attribute:: Columns
See :meth:`~wx.Choice.GetColumns` and :meth:`~wx.Choice.SetColumns`
.. attribute:: Count
See :meth:`~wx.Choice.GetCount`
.. attribute:: CurrentSelection
See :meth:`~wx.Choice.GetCurrentSelection`
.. attribute:: Selection
See :meth:`~wx.Choice.GetSelection` and :meth:`~wx.Choice.SetSelection`
|
