]>
Commit | Line | Data |
---|---|---|
23324ae1 FM |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: power.h | |
e54c96f1 | 3 | // Purpose: interface of wxPowerEvent |
23324ae1 FM |
4 | // Author: wxWidgets team |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | /** | |
10 | @class wxPowerEvent | |
11 | @wxheader{power.h} | |
7c913512 | 12 | |
23324ae1 FM |
13 | The power events are generated when the system power state changes, e.g. the |
14 | system is suspended, hibernated, plugged into or unplugged from the wall socket | |
15 | and so on. | |
7c913512 | 16 | |
23324ae1 FM |
17 | Notice that currently only suspend and resume events are generated and only |
18 | under MS Windows platform. To avoid the need to change the code using this | |
19 | event later when these events are implemented on the other platforms please use | |
20 | the test @c ifdef wxHAS_POWER_EVENTS instead of directly testing for | |
21 | the platform in your code: this symbol will be defined for all platforms | |
22 | supporting the power events. | |
7c913512 | 23 | |
23324ae1 FM |
24 | @library{wxbase} |
25 | @category{FIXME} | |
7c913512 | 26 | |
e54c96f1 | 27 | @see wxGetPowerType(), wxGetBatteryState() |
23324ae1 FM |
28 | */ |
29 | class wxPowerEvent : public wxEvent | |
30 | { | |
31 | public: | |
32 | /** | |
7c913512 | 33 | Call this to prevent suspend from taking place in |
23324ae1 FM |
34 | @c wxEVT_POWER_SUSPENDING handler (it is ignored for all the others). |
35 | */ | |
36 | void Veto(); | |
37 | }; | |
e54c96f1 | 38 |