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
|
.. 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.ItemContainerImmutable:
==========================================================================================================================================
|phoenix_title| **wx.ItemContainerImmutable**
==========================================================================================================================================
:ref:`wx.ItemContainer` defines an interface which is implemented by all controls which have string subitems each of which may be selected.
It is decomposed in :ref:`wx.ItemContainerImmutable` which omits all methods adding/removing items and is used by :ref:`wx.RadioBox` and :ref:`wx.ItemContainer` itself.
Note that this is not a control, it's a mixin interface that classes have to derive from in addition to :ref:`wx.Control` or :ref:`wx.Window`.
Examples: :ref:`wx.ListBox`, :ref:`wx.CheckListBox`, :ref:`wx.Choice` and :ref:`wx.ComboBox` (which implements an extended interface deriving from this one)
.. seealso:: :ref:`wx.ControlWithItems`, :ref:`wx.ItemContainer`
|
|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>ItemContainerImmutable</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.ItemContainerImmutable_inheritance.png" alt="Inheritance diagram of ItemContainerImmutable" 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.ItemContainerImmutable.html" title="wx.ItemContainerImmutable" alt="" coords="5,5,208,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.ItemContainer`, :ref:`wx.RadioBox`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ItemContainerImmutable.__init__` Constructor.
:meth:`~wx.ItemContainerImmutable.FindString` Finds an item whose label matches the given string.
:meth:`~wx.ItemContainerImmutable.GetCount` Returns the number of items in the control.
:meth:`~wx.ItemContainerImmutable.GetSelection` Returns the index of the selected item or ``NOT_FOUND`` if no item is selected.
:meth:`~wx.ItemContainerImmutable.GetString` Returns the label of the item with the given index.
:meth:`~wx.ItemContainerImmutable.GetStringSelection` Returns the label of the selected item or an empty string if no item is selected.
:meth:`~wx.ItemContainerImmutable.GetStrings` Returns the array of the labels of all items in the control.
:meth:`~wx.ItemContainerImmutable.IsEmpty` Returns ``True`` if the control is empty or ``False`` if it has some items.
:meth:`~wx.ItemContainerImmutable.Select` This is the same as :meth:`~ItemContainerImmutable.SetSelection` and exists only because it is slightly more natural for controls which support multiple selection.
:meth:`~wx.ItemContainerImmutable.SetSelection` Sets the selection to the given item `n` or removes the selection entirely if `n` == ``NOT_FOUND`` .
:meth:`~wx.ItemContainerImmutable.SetString` Sets the label for the given item.
:meth:`~wx.ItemContainerImmutable.SetStringSelection` Selects the item with the specified string in the control.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ItemContainerImmutable.Count` See :meth:`~wx.ItemContainerImmutable.GetCount`
:attr:`~wx.ItemContainerImmutable.Selection` See :meth:`~wx.ItemContainerImmutable.GetSelection` and :meth:`~wx.ItemContainerImmutable.SetSelection`
:attr:`~wx.ItemContainerImmutable.StringSelection` See :meth:`~wx.ItemContainerImmutable.GetStringSelection` and :meth:`~wx.ItemContainerImmutable.SetStringSelection`
:attr:`~wx.ItemContainerImmutable.Strings` See :meth:`~wx.ItemContainerImmutable.GetStrings`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ItemContainerImmutable(object)
**Possible constructors**::
ItemContainerImmutable()
ItemContainer defines an interface which is implemented by all
controls which have string subitems each of which may be selected.
.. method:: __init__(self)
Constructor.
.. 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:: GetCount(self)
Returns the number of items in the control.
:rtype: `int`
.. seealso:: :meth:`IsEmpty`
.. 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:: GetStringSelection(self)
Returns the label of the selected item or an empty string if no item is selected.
:rtype: `string`
.. seealso:: :meth:`GetSelection`
.. method:: GetStrings(self)
Returns the array of the labels of all items in the control.
:rtype: `list of strings`
.. method:: IsEmpty(self)
Returns ``True`` if the control is empty or ``False`` if it has some items.
:rtype: `bool`
.. seealso:: :meth:`GetCount`
.. method:: Select(self, n)
This is the same as :meth:`SetSelection` and exists only because it is slightly more natural for controls which support multiple selection.
:param `n`:
:type `n`: int
.. 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
.. method:: SetStringSelection(self, string)
Selects the item with the specified string in the control.
This method doesn't cause any command events to be emitted.
Notice that this method is case-insensitive, i.e. the string is compared with all the elements of the control case-insensitively and the first matching entry is selected, even if it doesn't have exactly the same case as this string and there is an exact match afterwards.
:param `string`: The string to select.
:type `string`: string
:rtype: `bool`
:returns:
``True`` if the specified string has been selected, ``False`` if it wasn't found in the control.
.. attribute:: Count
See :meth:`~wx.ItemContainerImmutable.GetCount`
.. attribute:: Selection
See :meth:`~wx.ItemContainerImmutable.GetSelection` and :meth:`~wx.ItemContainerImmutable.SetSelection`
.. attribute:: StringSelection
See :meth:`~wx.ItemContainerImmutable.GetStringSelection` and :meth:`~wx.ItemContainerImmutable.SetStringSelection`
.. attribute:: Strings
See :meth:`~wx.ItemContainerImmutable.GetStrings`
|
