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
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Icon:
==========================================================================================================================================
|phoenix_title| **wx.Icon**
==========================================================================================================================================
An icon is a small rectangular bitmap usually used for denoting a minimized application.
It differs from a :ref:`wx.Bitmap` in always having a mask associated with it for transparent drawing. On some platforms, icons and bitmaps are implemented identically, since there is no real distinction between a :ref:`wx.Bitmap` with a mask and an icon; and there is no specific icon format on some platforms (X-based applications usually standardize on XPMs for small bitmaps and icons). However, some platforms (such as Windows) make the distinction, so a separate class is provided.
.. note::
It is usually desirable to associate a pertinent icon with a frame. Icons can also be used for other purposes, for example with :ref:`wx.TreeCtrl` and :ref:`wx.ListCtrl`. Icons have different formats on different platforms therefore separate icons will usually be created for the different environments. Platform-specific methods for creating a :ref:`wx.Icon` structure are catered for, and this is an occasion where conditional compilation will probably be required. Note that a new icon must be created for every time the icon is to be used for a new window. In Windows, the icon will not be reloaded if it has already been used. An icon allocated to a frame will be deleted when the frame is deleted. For more information please see :ref:`Bitmaps and Icons <bitmaps and icons>`.
.. seealso:: :ref:`Bitmaps and Icons <bitmaps and icons>`, :ref:`Supported Bitmap File Formats <supported bitmap file formats>`, :ref:`wx.IconBundle`, :meth:`wx.DC.DrawIcon` , :ref:`wx.Cursor`
|
|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>Icon</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.Icon_inheritance.png" alt="Inheritance diagram of Icon" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Icon.html" title="wx.Icon" alt="" coords="25,160,97,189"/> <area shape="rect" id="node2" href="wx.GDIObject.html" title="wx.GDIObject" alt="" coords="5,83,116,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="17,5,104,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Icon.__init__` Default constructor.
:meth:`~wx.Icon.CopyFromBitmap` Copies `bmp` bitmap to this icon.
:meth:`~wx.Icon.CreateFromHICON` MSW-only method to create a wx.Icon from a native icon handle.
:meth:`~wx.Icon.GetDepth` Gets the colour depth of the icon.
:meth:`~wx.Icon.GetHandle`
:meth:`~wx.Icon.GetHeight` Gets the height of the icon in physical pixels.
:meth:`~wx.Icon.GetLogicalHeight` Gets the height of the icon in logical pixels.
:meth:`~wx.Icon.GetLogicalSize` Gets the size of the icon in logical pixels.
:meth:`~wx.Icon.GetLogicalWidth` Gets the width of the icon in logical pixels.
:meth:`~wx.Icon.GetScaleFactor` Gets the scale factor of this icon.
:meth:`~wx.Icon.GetSize` Gets the size of the icon in physical pixels.
:meth:`~wx.Icon.GetWidth` Gets the width of the icon in physical pixels.
:meth:`~wx.Icon.IsOk` Returns ``True`` if icon data is present.
:meth:`~wx.Icon.LoadFile` Loads an icon from a file or resource.
:meth:`~wx.Icon.SetDepth`
:meth:`~wx.Icon.SetHandle`
:meth:`~wx.Icon.SetHeight`
:meth:`~wx.Icon.SetWidth`
:meth:`~wx.Icon.__bool__`
:meth:`~wx.Icon.__nonzero__`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Icon.Depth` See :meth:`~wx.Icon.GetDepth` and :meth:`~wx.Icon.SetDepth`
:attr:`~wx.Icon.Handle` See :meth:`~wx.Icon.GetHandle` and :meth:`~wx.Icon.SetHandle`
:attr:`~wx.Icon.Height` See :meth:`~wx.Icon.GetHeight` and :meth:`~wx.Icon.SetHeight`
:attr:`~wx.Icon.LogicalHeight` See :meth:`~wx.Icon.GetLogicalHeight`
:attr:`~wx.Icon.LogicalSize` See :meth:`~wx.Icon.GetLogicalSize`
:attr:`~wx.Icon.LogicalWidth` See :meth:`~wx.Icon.GetLogicalWidth`
:attr:`~wx.Icon.ScaleFactor` See :meth:`~wx.Icon.GetScaleFactor`
:attr:`~wx.Icon.Size` See :meth:`~wx.Icon.GetSize`
:attr:`~wx.Icon.Width` See :meth:`~wx.Icon.GetWidth` and :meth:`~wx.Icon.SetWidth`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Icon(GDIObject)
**Possible constructors**::
Icon()
Icon(icon)
Icon(name, type=BITMAP_TYPE_ANY, desiredWidth=-1, desiredHeight=-1)
Icon(loc)
Icon(bmp)
An icon is a small rectangular bitmap usually used for denoting a
minimized application.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor.
Constructs an icon object with no data; an assignment or another member function such as :meth:`LoadFile` must be called subsequently.
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, icon)`
Copy constructor.
:param `icon`:
:type `icon`: wx.Icon
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, name, type=BITMAP_TYPE_ANY, desiredWidth=-1, desiredHeight=-1)`
Loads an icon from a file or resource.
:param `name`: This can refer to a resource name or a filename under MS Windows and X. Its meaning is determined by the `type` parameter.
:type `name`: string
:param `type`: May be one of the :ref:`wx.BitmapType` values and indicates which type of bitmap should be loaded. See the note in the class detailed description. Note that the ``ICON_DEFAULT_TYPE`` constant has different value under different wxWidgets ports. See the :ref:`icon.h` header for the value it takes for a specific port.
:type `type`: wx.BitmapType
:param `desiredWidth`: Specifies the desired width of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
:type `desiredWidth`: int
:param `desiredHeight`: Specifies the desired height of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
:type `desiredHeight`: int
.. seealso:: :meth:`LoadFile`
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, loc)`
Loads an icon from the specified location.
:param `loc`:
:type `loc`: wx.IconLocation
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, bmp)`
Construct an Icon from a Bitmap.
:html:`<hr class="overloadsep" /><br />`
.. method:: CopyFromBitmap(self, bmp)
Copies `bmp` bitmap to this icon.
Under MS Windows the bitmap must have mask colour set.
:param `bmp`:
:type `bmp`: wx.Bitmap
.. seealso:: :meth:`LoadFile`
.. method:: CreateFromHICON(self, hicon)
MSW-only method to create a wx.Icon from a native icon handle.
:rtype: `bool`
.. method:: GetDepth(self)
Gets the colour depth of the icon.
A value of 1 indicates a monochrome icon.
:rtype: `int`
.. method:: GetHandle(self)
:rtype: `long`
.. method:: GetHeight(self)
Gets the height of the icon in physical pixels.
:rtype: `int`
.. seealso:: :meth:`GetWidth` , :meth:`GetLogicalHeight`
.. method:: GetLogicalHeight(self)
Gets the height of the icon in logical pixels.
See :meth:`wx.Bitmap.GetLogicalHeight` .
:rtype: `float`
.. versionadded:: 4.1/wxWidgets-3.1.6
.. method:: GetLogicalSize(self)
Gets the size of the icon in logical pixels.
See :meth:`wx.Bitmap.GetLogicalSize` .
:rtype: :ref:`wx.Size`
.. versionadded:: 4.1/wxWidgets-3.1.6
.. method:: GetLogicalWidth(self)
Gets the width of the icon in logical pixels.
See :meth:`wx.Bitmap.GetLogicalWidth` .
:rtype: `float`
.. versionadded:: 4.1/wxWidgets-3.1.6
.. method:: GetScaleFactor(self)
Gets the scale factor of this icon.
See :meth:`wx.Bitmap.GetScaleFactor` .
:rtype: `float`
.. versionadded:: 4.1/wxWidgets-3.1.6
.. method:: GetSize(self)
Gets the size of the icon in physical pixels.
:rtype: :ref:`wx.Size`
.. seealso:: :meth:`GetLogicalSize`
.. method:: GetWidth(self)
Gets the width of the icon in physical pixels.
:rtype: `int`
.. seealso:: :meth:`GetHeight` , :meth:`GetLogicalWidth`
.. method:: IsOk(self)
Returns ``True`` if icon data is present.
:rtype: `bool`
.. method:: LoadFile(self, name, type=BITMAP_TYPE_ANY, desiredWidth=-1, desiredHeight=-1)
Loads an icon from a file or resource.
:param `name`: Either a filename or a Windows resource name. The meaning of name is determined by the `type` parameter.
:type `name`: string
:param `type`: One of the :ref:`wx.BitmapType` values; see the note in the class detailed description. Note that the ``ICON_DEFAULT_TYPE`` constant has different value under different wxWidgets ports. See the :ref:`icon.h` header for the value it takes for a specific port.
:type `type`: wx.BitmapType
:param `desiredWidth`: Specifies the desired width of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
:type `desiredWidth`: int
:param `desiredHeight`: Specifies the desired height of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
:type `desiredHeight`: int
:rtype: `bool`
:returns:
``True`` if the operation succeeded, ``False`` otherwise.
.. method:: SetDepth(self, depth)
Sets the depth member (does not affect the icon data).
:param `depth`: Icon depth.
:type `depth`: int
.. wxdeprecated::
This function is deprecated since version 3.1.2, dimensions and depth can only be set at construction time.
.. method:: SetHandle(self, handle)
.. method:: SetHeight(self, height)
Sets the height member (does not affect the icon data).
:param `height`: Icon height in pixels.
:type `height`: int
.. wxdeprecated::
This function is deprecated since version 3.1.2, dimensions and depth can only be set at construction time.
.. method:: SetWidth(self, width)
Sets the width member (does not affect the icon data).
:param `width`: Icon width in pixels.
:type `width`: int
.. wxdeprecated::
This function is deprecated since version 3.1.2, dimensions and depth can only be set at construction time.
.. method:: __bool__(self)
:rtype: `int`
.. method:: __nonzero__(self)
:rtype: `int`
.. attribute:: Depth
See :meth:`~wx.Icon.GetDepth` and :meth:`~wx.Icon.SetDepth`
.. attribute:: Handle
See :meth:`~wx.Icon.GetHandle` and :meth:`~wx.Icon.SetHandle`
.. attribute:: Height
See :meth:`~wx.Icon.GetHeight` and :meth:`~wx.Icon.SetHeight`
.. attribute:: LogicalHeight
See :meth:`~wx.Icon.GetLogicalHeight`
.. attribute:: LogicalSize
See :meth:`~wx.Icon.GetLogicalSize`
.. attribute:: LogicalWidth
See :meth:`~wx.Icon.GetLogicalWidth`
.. attribute:: ScaleFactor
See :meth:`~wx.Icon.GetScaleFactor`
.. attribute:: Size
See :meth:`~wx.Icon.GetSize`
.. attribute:: Width
See :meth:`~wx.Icon.GetWidth` and :meth:`~wx.Icon.SetWidth`
|
