wx.IconLocation

Inheritance diagram for wx.IconLocation:

Description

wx.IconLocation is a tiny class describing the location of an (external, i.e. not embedded into the application resources) icon.

For most platforms it simply contains the file name but under some others (notably Windows) the same file may contain multiple icons and so this class also stores the index of the icon inside the file.

In any case, its details should be of no interest to the application code and most of them are not even documented here (on purpose) as it is only meant to be used as an opaque class: the application may get the object of this class from somewhere and the only reasonable thing to do with it later is to create a wx.Icon from it.

See also

wx.Icon, wx.FileType.GetIcon

Methods Summary

• __init__
• GetFileName
• GetIndex
• IsOk
• SetFileName
• SetIndex

Properties Summary

• FileName
• Index

Class API

Methods

__init__(filename="", num=0)

Constructor.

Parameters:

• filename (string)
• num (int)

Returns:

wx.IconLocation

---

GetFileName()

No docstrings available for this method.

---

GetIndex()

No docstrings available for this method.

---

IsOk()

Returns True if the object is valid, i.e. was properly initialized, and False otherwise.

Returns:

bool

---

SetFileName(filename)

Parameters:

• filename (string)

---

SetIndex(num)

Parameters:

• num (int)

---

Properties

FileName

See GetFileName and SetFileName

Index

See GetIndex and SetIndex