]> git.saurik.com Git - wxWidgets.git/blob - include/wx/power.h
synchronize GTK2 minimum version in docs
[wxWidgets.git] / include / wx / power.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/power.h
3 // Purpose: functions and classes for system power management
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 2006-05-27
7 // RCS-ID: $Id$
8 // Copyright: (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_POWER_H_
13 #define _WX_POWER_H_
14
15 #include "wx/event.h"
16
17 // ----------------------------------------------------------------------------
18 // power management constants
19 // ----------------------------------------------------------------------------
20
21 enum wxPowerType
22 {
23 wxPOWER_SOCKET,
24 wxPOWER_BATTERY,
25 wxPOWER_UNKNOWN
26 };
27
28 enum wxBatteryState
29 {
30 wxBATTERY_NORMAL_STATE, // system is fully usable
31 wxBATTERY_LOW_STATE, // start to worry
32 wxBATTERY_CRITICAL_STATE, // save quickly
33 wxBATTERY_SHUTDOWN_STATE, // too late
34 wxBATTERY_UNKNOWN_STATE
35 };
36
37 // ----------------------------------------------------------------------------
38 // wxPowerEvent is generated when the system online status changes
39 // ----------------------------------------------------------------------------
40
41 // currently the power events are only available under Windows, to avoid
42 // compiling in the code for handling them which is never going to be invoked
43 // under the other platforms, we define wxHAS_POWER_EVENTS symbol if this event
44 // is available, it should be used to guard all code using wxPowerEvent
45 #ifdef __WINDOWS__
46
47 #define wxHAS_POWER_EVENTS
48
49 class WXDLLIMPEXP_BASE wxPowerEvent : public wxEvent
50 {
51 public:
52 wxPowerEvent() // just for use by wxRTTI
53 : m_veto(false) { }
54
55 wxPowerEvent(wxEventType evtType) : wxEvent(wxID_NONE, evtType)
56 {
57 m_veto = false;
58 }
59
60 // Veto the operation (only makes sense with EVT_POWER_SUSPENDING)
61 void Veto() { m_veto = true; }
62
63 bool IsVetoed() const { return m_veto; }
64
65
66 // default copy ctor, assignment operator and dtor are ok
67
68 virtual wxEvent *Clone() const { return new wxPowerEvent(*this); }
69
70 private:
71 bool m_veto;
72
73 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPowerEvent)
74 };
75
76 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_BASE, wxEVT_POWER_SUSPENDING, wxPowerEvent );
77 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_BASE, wxEVT_POWER_SUSPENDED, wxPowerEvent );
78 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_BASE, wxEVT_POWER_SUSPEND_CANCEL, wxPowerEvent );
79 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_BASE, wxEVT_POWER_RESUME, wxPowerEvent );
80
81 typedef void (wxEvtHandler::*wxPowerEventFunction)(wxPowerEvent&);
82
83 #define wxPowerEventHandler(func) \
84 wxEVENT_HANDLER_CAST(wxPowerEventFunction, func)
85
86 #define EVT_POWER_SUSPENDING(func) \
87 wx__DECLARE_EVT0(wxEVT_POWER_SUSPENDING, wxPowerEventHandler(func))
88 #define EVT_POWER_SUSPENDED(func) \
89 wx__DECLARE_EVT0(wxEVT_POWER_SUSPENDED, wxPowerEventHandler(func))
90 #define EVT_POWER_SUSPEND_CANCEL(func) \
91 wx__DECLARE_EVT0(wxEVT_POWER_SUSPEND_CANCEL, wxPowerEventHandler(func))
92 #define EVT_POWER_RESUME(func) \
93 wx__DECLARE_EVT0(wxEVT_POWER_RESUME, wxPowerEventHandler(func))
94
95 #else // no support for power events
96 #undef wxHAS_POWER_EVENTS
97 #endif // support for power events/no support
98
99 // ----------------------------------------------------------------------------
100 // power management functions
101 // ----------------------------------------------------------------------------
102
103 // return the current system power state: online or offline
104 WXDLLIMPEXP_BASE wxPowerType wxGetPowerType();
105
106 // return approximate battery state
107 WXDLLIMPEXP_BASE wxBatteryState wxGetBatteryState();
108
109 #endif // _WX_POWER_H_