*************
wx.PowerEvent
*************

Inheritance diagram for `wx.PowerEvent`:

|

.. inheritance-diagram:: wx.PowerEvent

|

Description
===========

The power events are generated when the system power state changes, e.g. the system is suspended, hibernated, plugged into or unplugged from the wall socket and so on.

.. note:: Notice that currently only suspend and resume events are generated and only under MS Windows platform. 

.. seealso:: `wx.GetPowerType <../wxFunctions.html#GetPowerType>`_, `wx.GetBatteryState <../wxFunctions.html#GetBatteryState>`_


Derived From
^^^^^^^^^^^^^

* `wx.Event <wx.Event.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 


Event Handling
^^^^^^^^^^^^^^

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.EVT_POWER_SUSPENDING(func)                       System is about to be suspended, this event can be vetoed to prevent suspend from taking place.  
wx.EVT_POWER_SUSPENDED(func)                        System is about to suspend: normally the application should quickly (i.e. without user intervention) close all the open files and network connections here, possibly remembering them to reopen them later when the system is resumed.  
wx.EVT_POWER_SUSPEND_CANCEL(func)                   System suspension was cancelled because some application vetoed it.  
wx.EVT_POWER_RESUME(func)                           System resumed from suspend: normally the application should restore the state in which it had been before the suspension.  
==================================================  ==================================================  


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

* `__init__ <#__init__>`_ 
* `IsVetoed <#IsVetoed>`_ 
* `Veto <#Veto>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(evtType)

   `wx.PowerEvent` is generated when the system online status changes.
   Currently this is only implemented for Windows.
   
   **Parameters:**

   * `evtType` (eventtype)

   |

   **Returns:**

   `wx.PowerEvent <wx.PowerEvent.html>`_
 

--------

.. method:: IsVetoed()

   `No docstrings available for this method.` 

--------


.. method:: Veto()

   Call this to prevent suspend from taking place in ``wx.EVT_POWER_SUSPENDING`` handler (it is ignored for all the others).