***************
wx.IconLocation
***************

Inheritance diagram for `wx.IconLocation`:

|

.. inheritance-diagram:: 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 <wx.Icon.html>`_ from it.


.. seealso:: `wx.Icon <wx.Icon.html>`_, `wx.FileType.GetIcon <wx.FileType.html#GetIcon>`_


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetFileName <#GetFileName>`_ 
* `GetIndex <#GetIndex>`_ 
* `IsOk <#IsOk>`_ 
* `SetFileName <#SetFileName>`_ 
* `SetIndex <#SetIndex>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `FileName <#FileName>`_ 
* `Index <#Index>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(filename="", num=0)

   Constructor.

   **Parameters:**

   * `filename` (string)
   * `num` (int)

   |

   **Returns:**

   `wx.IconLocation <wx.IconLocation.html>`_
 

--------

.. method:: GetFileName()

   `No docstrings available for this method.` 

--------


.. method:: GetIndex()

   `No docstrings available for this method.` 

--------


.. method:: IsOk()

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

   |  

   **Returns:**

   `bool` 

--------

.. method:: SetFileName(filename)

   |   
   
   **Parameters:**

   * `filename` (string)

--------

.. method:: SetIndex(num)

   |

   **Parameters:**

   * `num` (int)

--------

Properties
^^^^^^^^^^


.. attribute:: FileName

   See `GetFileName <#GetFileName>`_ and `SetFileName <#SetFileName>`_

.. attribute:: Index

   See `GetIndex <#GetIndex>`_ and `SetIndex <#SetIndex>`_