wx.IconBundle

This class contains multiple copies of an icon in different sizes.

It is typically used in wx.Dialog.SetIcons and wx.TopLevelWindow.SetIcons .

Class Hierarchy

Inheritance diagram for class IconBundle:

Methods Summary

__init__	Default constructor.
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.
GetIcon	Returns the icon with the given size.
GetIconByIndex	return the icon at index (must be < GetIconCount )
GetIconCount	return the number of available icons
GetIconOfExactSize	Returns the icon with exactly the given size or wx.NullIcon if this size is not available.
IsEmpty	Returns True if the bundle doesn’t contain any icons, False otherwise (in which case a call to GetIcon with default parameter should return a valid icon).

Properties Summary

Icon	See GetIcon
IconCount	See GetIconCount

Class API

class wx.IconBundle(GDIObject)

Possible constructors:

IconBundle() -> None

IconBundle(file, type=BITMAP_TYPE_ANY) -> None

IconBundle(stream, type=BITMAP_TYPE_ANY) -> None

IconBundle(icon) -> None

IconBundle(ic) -> None

This class contains multiple copies of an icon in different sizes.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

Return type:

None

---

__init__ (self, file, type=BITMAP_TYPE_ANY)

Initializes the bundle with the icon(s) found in the file.

Parameters:

• file (string)

• type (BitmapType)

Return type:

None

---

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

Parameters:

• stream (wx.InputStream)

• type (BitmapType)

Return type:

None

Added in version 2.9.0.

---

__init__ (self, icon)

Initializes the bundle with a single icon.

Parameters:

icon (wx.Icon)

Return type:

None

---

__init__ (self, ic)

Copy constructor.

Parameters:

ic (wx.IconBundle)

Return type:

None

---

---

AddIcon(self, *args, **kw)

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.

Parameters:

• file (string)

• type (BitmapType)

Return type:

None

---

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.

Parameters:

• stream (wx.InputStream)

• type (BitmapType)

Return type:

None

Added in version 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.

Parameters:

icon (wx.Icon)

Return type:

None

---

---

GetIcon(self, *args, **kw)

Overloaded Implementations:

---

GetIcon (self, size, flags=FALLBACK_SYSTEM)

Returns the icon with the given size.

If size is wx.DefaultSize , it is interpreted as the standard system icon size, i.e. the size returned by 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 wx.IconBundle.FALLBACK_NONE is given, the function returns an invalid icon. If 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 either, but 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.

Parameters:

• size (wx.Size)

• flags (int)

Return type:

wx.Icon

---

GetIcon (self, size=DefaultCoord, flags=FALLBACK_SYSTEM)

Same as.

GetIcon(wx.Size(size, size))

Parameters:

• size (int)

• flags (int)

Return type:

wx.Icon

---

---

GetIconByIndex(self, n)

return the icon at index (must be < GetIconCount )

Parameters:

n (int)

Return type:

wx.Icon

---

GetIconCount(self)

return the number of available icons

Return type:

int

---

GetIconOfExactSize(self, size)

Returns the icon with exactly the given size or wx.NullIcon if this size is not available.

Parameters:

size (wx.Size)

Return type:

wx.Icon

---

IsEmpty(self)

Returns True if the bundle doesn’t contain any icons, False otherwise (in which case a call to GetIcon with default parameter should return a valid icon).

Return type:

bool

Properties

Icon

See GetIcon

---

IconCount

See GetIconCount