# wx.Icon¶

An icon is a small rectangular bitmap usually used for denoting a minimized application.

It differs from a 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 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 wx.TreeCtrl and 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 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 Bitmaps and Icons.

## Class Hierarchy¶

Inheritance diagram for class Icon:

## Methods Summary¶

 __init__ Default constructor. CopyFromBitmap Copies bmp bitmap to this icon. CreateFromHICON MSW-only method to create a wx.Icon from a native icon handle. GetDepth Gets the colour depth of the icon. GetHandle GetHeight Gets the height of the icon in pixels. GetWidth Gets the width of the icon in pixels. IsOk Returns True if icon data is present. LoadFile Loads an icon from a file or resource. SetDepth Sets the depth member (does not affect the icon data). SetHandle SetHeight Sets the height member (does not affect the icon data). SetWidth Sets the width member (does not affect the icon data). __bool__ __nonzero__

## 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.

### Methods¶

__init__(self, *args, **kw)

__init__ (self)

Default constructor.

Constructs an icon object with no data; an assignment or another member function such as LoadFile must be called subsequently.

__init__ (self, icon)

Copy constructor.

Parameters

icon (wx.Icon) –

__init__ (self, name, type=BITMAP_TYPE_ANY, desiredWidth=-1, desiredHeight=-1)

Loads an icon from a file or resource.

Parameters
• name (string) – This can refer to a resource name or a filename under MS Windows and X. Its meaning is determined by the type parameter.

• type (BitmapType) – May be one of the 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 icon.h header for the value it takes for a specific port.

• desiredWidth (int) – 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.

• desiredHeight (int) – 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.

__init__ (self, loc)

Loads an icon from the specified location.

Parameters

loc (wx.IconLocation) –

__init__ (self, bmp)

Construct an Icon from a Bitmap.

CopyFromBitmap(self, bmp)

Copies bmp bitmap to this icon.

Under MS Windows the bitmap must have mask colour set.

Parameters

bmp (wx.Bitmap) –

CreateFromHICON(self, hicon)

MSW-only method to create a wx.Icon from a native icon handle.

Return type

bool

GetDepth(self)

Gets the colour depth of the icon.

A value of 1 indicates a monochrome icon.

Return type

int

GetHandle(self)
Return type

long

GetHeight(self)

Gets the height of the icon in pixels.

Return type

int

GetWidth(self)

Gets the width of the icon in pixels.

Return type

int

IsOk(self)

Returns True if icon data is present.

Return type

bool

LoadFile(self, name, type=BITMAP_TYPE_ANY, desiredWidth=-1, desiredHeight=-1)

Loads an icon from a file or resource.

Parameters
• name (string) – Either a filename or a Windows resource name. The meaning of name is determined by the type parameter.

• type (BitmapType) – One of the 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 icon.h header for the value it takes for a specific port.

• desiredWidth (int) – 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.

• desiredHeight (int) – 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.

Return type

bool

Returns

True if the operation succeeded, False otherwise.

SetDepth(self, depth)

Sets the depth member (does not affect the icon data).

Parameters

depth (int) – Icon depth.

SetHandle(self, handle)

SetHeight(self, height)

Sets the height member (does not affect the icon data).

Parameters

height (int) – Icon height in pixels.

SetWidth(self, width)

Sets the width member (does not affect the icon data).

Parameters

width (int) – Icon width in pixels.

__bool__(self)
Return type

int

__nonzero__(self)
Return type

int

### Properties¶

Depth

Handle

Height

Width