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.

events Events Emitted by this Class

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

  • EVT_POWER_SUSPENDING:

    Warning

    This event and the possibility to veto suspend was removed from MSW systems starting from Windows Vista. wx.PowerResourceBlocker can be used to prevent the system from suspending under both XP and later systems, use it instead of handling this event.

  • 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.


class_hierarchy Class Hierarchy

Inheritance diagram for class PowerEvent:

method_summary Methods Summary

__init__

IsVetoed

Returns whether Veto has been called.

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.


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)



__init__ (self, evtType)

Parameters

evtType (wx.EventType) –





IsVetoed(self)

Returns whether Veto has been called.

Return type

bool



Veto(self)

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