Phoenix Logo

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


class_hierarchy Class Hierarchy

Inheritance diagram for class IconLocation:


method_summary Methods Summary

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

property_summary Properties Summary

FileName See GetFileName and SetFileName
Index See GetIndex and SetIndex

api Class API



class wx.IconLocation(object)

Possible constructors:

IconLocation()

IconLocation(filename, num=0)

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


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)



__init__ (self, filename, num=0)





GetFileName(self)
Return type:string


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)
Parameters:filename (string) –


SetIndex(self, num)


__nonzero__(self)
Return type:int

Properties



FileName

See GetFileName and SetFileName



Index

See GetIndex and SetIndex