.. include:: headings.inc



.. _ActivateEvent:

==========================================================================================================================================
|phoenix_title|  **ActivateEvent**
==========================================================================================================================================

An activate event is sent when a window or application is being activated or deactivated.          





.. _ActivateEvent-events:

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

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

- EVT_ACTIVATE: Process a  ``wxEVT_ACTIVATE``   event.   
- EVT_ACTIVATE_APP: Process a  ``wxEVT_ACTIVATE_APP``   event. This event is received by the App-derived instance only.   
- EVT_HIBERNATE: Process a hibernate event, supplying the member function. This event applies to :ref:`App`  only, and only on Windows SmartPhone and PocketPC. It is generated when the system is low on memory; the application should free up as much memory as possible, and restore full working state when it receives a  ``wxEVT_ACTIVATE``   or   ``wxEVT_ACTIVATE_APP``   event.   








         



.. seealso:: :ref:`Events and Event Handling <events and event handling>`, :meth:`App.IsActive`     







|

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

Inheritance diagram for class **ActivateEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/ActivateEvent_inheritance.png" alt="Inheritance diagram of ActivateEvent" 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="ActivateEvent.html" title="An activate event is sent when a window or application is being activated or deactivated." alt="" coords="247,5,364,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:`~ActivateEvent.__init__`                                                  Constructor.
:meth:`~ActivateEvent.GetActive`                                                 Returns ``True`` if the application or window is being activated, ``False`` otherwise.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~ActivateEvent.Active`                                                    See :meth:`~ActivateEvent.GetActive`
================================================================================ ================================================================================


|


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

.. class:: ActivateEvent(Event)

   An activate event is sent when a window or application is being activated or deactivated.
   
   **Possible constructors**::

       ActivateEvent(eventType=wxEVT_NULL, active=True, id=0)
       



   .. method:: __init__(self, eventType=wxEVT_NULL, active=True, id=0)

      Constructor.                  


      :param `eventType`: 
      :type `eventType`: EventType
      :param `active`: 
      :type `active`: bool
      :param `id`: 
      :type `id`: int







   .. method:: GetActive(self)

      Returns ``True`` if the application or window is being activated, ``False`` otherwise.                  

      :rtype: `bool`








   .. attribute:: Active

      See :meth:`~ActivateEvent.GetActive`