wx.IconLocation

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

Class Hierarchy

Inheritance diagram for class IconLocation:

Methods Summary

__init__
GetFileName
GetIndex
IsOk	Returns True if the object is valid, i.e. was properly initialized, and False otherwise.
SetFileName
SetIndex
__bool__
__nonzero__

Properties Summary

FileName	See GetFileName and SetFileName
Index	See GetIndex and SetIndex

Class API

class wx.IconLocation(object)

Possible constructors:

IconLocation() -> None

IconLocation(filename: str, num: int=0) -> None

IconLocation is a tiny class describing the location of an (external, i.e.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Return type:

None

---

__init__ (self, filename: str, num: int=0)

Return type:

None

---

---

GetFileName(self)

Return type:

str

---

GetIndex(self)

Return type:

int

---

IsOk(self)

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

Return type:

bool

---

SetFileName(self, filename : str)

Parameters:

filename (string) –

Return type:

None

---

SetIndex(self, num: int)

Return type:

None

---

__bool__(self)

Return type:

int

---

__nonzero__(self)

Return type:

int

Properties

FileName

See GetFileName and SetFileName

---

Index

See GetIndex and SetIndex