wxPowerEvent Class Reference
[Events]
#include <wx/power.h>
Inheritance diagram for wxPowerEvent:
Detailed 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.
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:
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
void handlerFuncName(wxPowerEvent& event)
Event macros:- EVT_POWER_SUSPENDING(func):: System is about to be suspended, this event can be vetoed to prevent suspend from taking place.
- 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.
- EVT_POWER_SUSPEND_CANCEL(func):: System suspension was cancelled because some application vetoed it.
- EVT_POWER_RESUME(func):: System resumed from suspend: normally the application should restore the state in which it had been before the suspension.
Library: wxBase
Category: Events
- See also:
- wxGetPowerType(), wxGetBatteryState()
Public Member Functions | |
| void | Veto () |
Member Function Documentation
| void wxPowerEvent::Veto | ( | ) |
Call this to prevent suspend from taking place in wxEVT_POWER_SUSPENDING handler (it is ignored for all the others).
