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
|
.. 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.IconBundle:
==========================================================================================================================================
|phoenix_title| **wx.IconBundle**
==========================================================================================================================================
This class contains multiple copies of an icon in different sizes.
It is typically used in :meth:`wx.Dialog.SetIcons` and :meth:`wx.TopLevelWindow.SetIcons` .
|
|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>IconBundle</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.IconBundle_inheritance.png" alt="Inheritance diagram of IconBundle" 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="19,5,100,35"/> <area shape="rect" id="node3" href="wx.GDIObject.html" title="wx.GDIObject" alt="" coords="7,83,113,112"/> <area shape="rect" id="node2" href="wx.IconBundle.html" title="wx.IconBundle" alt="" coords="4,160,115,189"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.IconBundle.__init__` Default constructor.
:meth:`~wx.IconBundle.AddIcon` Adds all the icons contained in the file to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
:meth:`~wx.IconBundle.GetIcon` Returns the icon with the given size.
:meth:`~wx.IconBundle.GetIconByIndex` return the icon at index (must be < :meth:`~IconBundle.GetIconCount` )
:meth:`~wx.IconBundle.GetIconCount` return the number of available icons
:meth:`~wx.IconBundle.GetIconOfExactSize` Returns the icon with exactly the given size or :ref:`wx.NullIcon` if this size is not available.
:meth:`~wx.IconBundle.IsEmpty` Returns ``True`` if the bundle doesn't contain any icons, ``False`` otherwise (in which case a call to :meth:`~IconBundle.GetIcon` with default parameter should return a valid icon).
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.IconBundle.Icon` See :meth:`~wx.IconBundle.GetIcon`
:attr:`~wx.IconBundle.IconCount` See :meth:`~wx.IconBundle.GetIconCount`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.IconBundle(GDIObject)
**Possible constructors**::
IconBundle()
IconBundle(file, type=BITMAP_TYPE_ANY)
IconBundle(stream, type=BITMAP_TYPE_ANY)
IconBundle(icon)
IconBundle(ic)
This class contains multiple copies of an icon in different sizes.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, file, type=BITMAP_TYPE_ANY)`
Initializes the bundle with the icon(s) found in the file.
:param `file`:
:type `file`: string
:param `type`:
:type `type`: wx.BitmapType
**~~~**
**__init__** `(self, stream, type=BITMAP_TYPE_ANY)`
Initializes the bundle with the icon(s) found in the stream.
Notice that the `stream` must be seekable, at least if it contains more than one icon. The stream pointer is positioned after the last icon read from the stream when this function returns.
:param `stream`:
:type `stream`: wx.InputStream
:param `type`:
:type `type`: wx.BitmapType
.. versionadded:: 2.9.0
**~~~**
**__init__** `(self, icon)`
Initializes the bundle with a single icon.
:param `icon`:
:type `icon`: wx.Icon
**~~~**
**__init__** `(self, ic)`
Copy constructor.
:param `ic`:
:type `ic`: wx.IconBundle
**~~~**
.. method:: AddIcon(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**AddIcon** `(self, file, type=BITMAP_TYPE_ANY)`
Adds all the icons contained in the file to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
:param `file`:
:type `file`: string
:param `type`:
:type `type`: wx.BitmapType
**~~~**
**AddIcon** `(self, stream, type=BITMAP_TYPE_ANY)`
Adds all the icons contained in the stream to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
Notice that, as well as in the constructor loading the icon bundle from stream, the `stream` must be seekable, at least if more than one icon is to be loaded from it.
:param `stream`:
:type `stream`: wx.InputStream
:param `type`:
:type `type`: wx.BitmapType
.. versionadded:: 2.9.0
**~~~**
**AddIcon** `(self, icon)`
Adds the icon to the collection; if the collection already contains an icon with the same width and height, it is replaced by the new one.
:param `icon`:
:type `icon`: wx.Icon
**~~~**
.. method:: GetIcon(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**GetIcon** `(self, size, flags=FALLBACK_SYSTEM)`
Returns the icon with the given size.
If `size` is :ref:`wx.DefaultSize`, it is interpreted as the standard system icon size, i.e. the size returned by :meth:`wx.SystemSettings.GetMetric` for ``SYS_ICON_X`` and ``SYS_ICON_Y`` .
If the bundle contains an icon with exactly the requested size, it's always returned. Otherwise, the behaviour depends on the flags. If only :meth:`wx.IconBundle.FALLBACK_NONE` is given, the function returns an invalid icon. If :meth:`wx.IconBundle.FALLBACK_SYSTEM` is given, it tries to find the icon of standard system size, regardless of the size passed as parameter. Otherwise, or if the icon system size is not found neither, but :meth:`wx.IconBundle.FALLBACK_NEAREST_LARGER` flag is specified, the function returns the smallest icon of the size larger than the requested one or, if this fails too, just the icon closest to the specified size.
The `flags` parameter is available only since wxWidgets 2.9.4.
:param `size`:
:type `size`: wx.Size
:param `flags`:
:type `flags`: int
:rtype: :ref:`wx.Icon`
**~~~**
**GetIcon** `(self, size=DefaultCoord, flags=FALLBACK_SYSTEM)`
Same as.
::
GetIcon(wx.Size(size, size))
:param `size`:
:type `size`: int
:param `flags`:
:type `flags`: int
:rtype: :ref:`wx.Icon`
**~~~**
.. method:: GetIconByIndex(self, n)
return the icon at index (must be < :meth:`GetIconCount` )
:param `n`:
:type `n`: int
:rtype: :ref:`wx.Icon`
.. method:: GetIconCount(self)
return the number of available icons
:rtype: `int`
.. method:: GetIconOfExactSize(self, size)
Returns the icon with exactly the given size or :ref:`wx.NullIcon` if this size is not available.
:param `size`:
:type `size`: wx.Size
:rtype: :ref:`wx.Icon`
.. method:: IsEmpty(self)
Returns ``True`` if the bundle doesn't contain any icons, ``False`` otherwise (in which case a call to :meth:`GetIcon` with default parameter should return a valid icon).
:rtype: `bool`
.. attribute:: Icon
See :meth:`~wx.IconBundle.GetIcon`
.. attribute:: IconCount
See :meth:`~wx.IconBundle.GetIconCount`
|
