Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
54
interface/wx/power.h
Normal file
54
interface/wx/power.h
Normal file
@@ -0,0 +1,54 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: power.h
|
||||
// Purpose: interface of wxPowerEvent
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
@class wxPowerEvent
|
||||
@wxheader{power.h}
|
||||
|
||||
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 <tt>ifdef wxHAS_POWER_EVENTS</tt> instead of directly testing for
|
||||
the platform in your code: this symbol will be defined for all platforms
|
||||
supporting the power events.
|
||||
|
||||
@beginEventTable{wxPowerEvent}
|
||||
@event{EVT_POWER_SUSPENDING(func)}:
|
||||
System is about to be suspended, this event can be vetoed to prevent
|
||||
suspend from taking place.
|
||||
@event{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.
|
||||
@event{EVT_POWER_SUSPEND_CANCEL(func)}:
|
||||
System suspension was cancelled because some application vetoed it.
|
||||
@event{EVT_POWER_RESUME(func)}:
|
||||
System resumed from suspend: normally the application should restore
|
||||
the state in which it had been before the suspension.
|
||||
@endEventTable
|
||||
|
||||
@library{wxbase}
|
||||
@category{events}
|
||||
|
||||
@see ::wxGetPowerType(), ::wxGetBatteryState()
|
||||
*/
|
||||
class wxPowerEvent : public wxEvent
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Call this to prevent suspend from taking place in @c wxEVT_POWER_SUSPENDING
|
||||
handler (it is ignored for all the others).
|
||||
*/
|
||||
void Veto();
|
||||
};
|
||||
|
Reference in New Issue
Block a user