.. include:: headings.inc



.. _IconizeEvent:

==========================================================================================================================================
|phoenix_title|  **IconizeEvent**
==========================================================================================================================================

An event being sent when the frame is iconized (minimized) or restored.          

Currently only wxMSW and wxGTK generate such events. 







.. _IconizeEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`IconizeEvent` parameter.

- EVT_ICONIZE: Process a  ``wxEVT_ICONIZE``   event.   








         



.. availability:: Only available for MSW, GTK.  







.. seealso:: :ref:`Events and Event Handling <events and event handling>`, :meth:`TopLevelWindow.Iconize` , :meth:`TopLevelWindow.IsIconized`     







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **IconizeEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/IconizeEvent_inheritance.png" alt="Inheritance diagram of IconizeEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node4" href="IconizeEvent.html" title="An event being sent when the frame is iconized (minimized) or restored." alt="" coords="245,5,360,35"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~IconizeEvent.__init__`                                                   Constructor.
:meth:`~IconizeEvent.Iconized`                                                   
:meth:`~IconizeEvent.IsIconized`                                                 Returns ``True`` if the frame has been iconized, ``False`` if it has been restored.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: IconizeEvent(Event)

   An event being sent when the frame is iconized (minimized) or restored.
   
   **Possible constructors**::

       IconizeEvent(id=0, iconized=True)
       



   .. method:: __init__(self, id=0, iconized=True)

      Constructor.                  


      :param `id`: 
      :type `id`: int
      :param `iconized`: 
      :type `iconized`: bool







   .. method:: Iconized(self)



                

      :rtype: `bool`







      .. deprecated:: 2.9.4
         2.9.4 







      .. deprecated:: 2.9.4
         This function is deprecated in favour of :meth:`IsIconized` .    








   .. method:: IsIconized(self)

      Returns ``True`` if the frame has been iconized, ``False`` if it has been restored.                  

      :rtype: `bool`