.. wxPython Phoenix documentation

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

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

.. include:: headings.inc



.. _wx.PowerEvent:

==========================================================================================================================================
|phoenix_title|  **wx.PowerEvent**
==========================================================================================================================================

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. PowerEvents are emitted by Windows. 

Notice that currently only suspend and resume events are generated and only under MS Windows platform. To avoid the need to change the code using this event later when these events are implemented on the other platforms please use the test  ``ifdef wxHAS_POWER_EVENTS``   instead of directly testing for the platform in your code: this symbol will be defined for all platforms supporting the power events. 







.. _PowerEvent-events:

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

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

 

- EVT_POWER_SUSPENDING: System is about to be suspended, this event can be vetoed to prevent suspend from taking place.  
- EVT_POWER_SUSPENDED: 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.  
- EVT_POWER_SUSPEND_CANCEL: System suspension was cancelled because some application vetoed it.  
- EVT_POWER_RESUME: System resumed from suspend: normally the application should restore the state in which it had been before the suspension.  








         



.. seealso:: `wx.GetPowerType`     , `wx.GetBatteryState`         







|

|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>PowerEvent</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.PowerEvent_inheritance.png" alt="Inheritance diagram of PowerEvent" 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="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="24,83,103,112"/> <area shape="rect" id="node3" href="wx.PowerEvent.html" title="The power events are generated when the system power state changes, e.g." alt="" coords="5,160,121,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="22,5,105,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~wx.PowerEvent.__init__`                                                  
:meth:`~wx.PowerEvent.IsVetoed`                                                  Returns whether Veto has been called.
:meth:`~wx.PowerEvent.Veto`                                                      Call this to prevent suspend from taking place in  ``wxEVT_POWER_SUSPENDING``   handler (it is ignored for all the others).
================================================================================ ================================================================================


|


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


.. class:: wx.PowerEvent(Event)

   **Possible constructors**::

       PowerEvent()
       
       PowerEvent(evtType)
       
   
   The power events are generated when the system power state changes,
   e.g.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      **~~~**

      
      **__init__** `(self)`
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, evtType)`
      
      
      
      
      :param `evtType`: 
      :type `evtType`: wx.EventType
      
      
      
      
      
      
      **~~~**






   .. method:: IsVetoed(self)

      Returns whether Veto has been called.                  

      :rtype: `bool`








   .. method:: Veto(self)

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