.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2017 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.IconizeEvent:

==========================================================================================================================================
|phoenix_title|  **wx.IconizeEvent**
==========================================================================================================================================

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









.. _IconizeEvent-events:

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

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

Event macros: 

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








         



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







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







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>IconizeEvent</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.IconizeEvent_inheritance.png" alt="Inheritance diagram of IconizeEvent" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Event.html" title="wx.Event" alt="" coords="27,83,105,112"/> <area shape="rect" id="node3" href="wx.IconizeEvent.html" title="wx.IconizeEvent" alt="" coords="5,160,128,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="25,5,107,35"/> </map> 
   </p>

|


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

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


|


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


.. class:: wx.IconizeEvent(Event)

   **Possible constructors**::

       IconizeEvent(id=0, iconized=True)
       
   
   An event being sent when the frame is iconized (minimized) or
   restored.



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

      Constructor.                  


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







   .. method:: Iconized(self)



                

      :rtype: `bool`







      .. deprecated:: 4.0.1
         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`







