Minor fixes to wxDateTime documentation.

[wxWidgets.git] / interface / wx / power.h

diff --git a/interface/wx/power.h b/interface/wx/power.h
index b54808f56218d72096bde7cff3a852b3b273b967..da34f5c41616b9a1f5c6f5a4e18e42d4895fee38 100644 (file)
--- a/interface/wx/power.h
+++ b/interface/wx/power.h
@@ -3,16 +3,32 @@
 // Purpose:     interface of wxPowerEvent
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxPowerEvent
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+enum wxPowerType
+{
+    wxPOWER_SOCKET,
+    wxPOWER_BATTERY,
+    wxPOWER_UNKNOWN
+};
+
+enum wxBatteryState
+{
+    wxBATTERY_NORMAL_STATE,    // system is fully usable
+    wxBATTERY_LOW_STATE,       // start to worry
+    wxBATTERY_CRITICAL_STATE,  // save quickly
+    wxBATTERY_SHUTDOWN_STATE,  // too late
+    wxBATTERY_UNKNOWN_STATE
+};
+
+

 /**
     @class wxPowerEvent
 /**
     @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
 
     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.
+    and so on. wxPowerEvents are emitted by wxWindows.

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


@@ -22,17 +38,17 @@
     supporting the power events.
 
     @beginEventTable{wxPowerEvent}
     supporting the power events.
 
     @beginEventTable{wxPowerEvent}

-    @event{EVT_POWER_SUSPENDING(func)}:
+    @event{EVT_POWER_SUSPENDING(func)}

            System is about to be suspended, this event can be vetoed to prevent
            suspend from taking place.
            System is about to be suspended, this event can be vetoed to prevent
            suspend from taking place.

-    @event{EVT_POWER_SUSPENDED(func)}:
+    @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.
            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)}:
+    @event{EVT_POWER_SUSPEND_CANCEL(func)}

            System suspension was cancelled because some application vetoed it.
            System suspension was cancelled because some application vetoed it.

-    @event{EVT_POWER_RESUME(func)}:
+    @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
            System resumed from suspend: normally the application should restore
            the state in which it had been before the suspension.
     @endEventTable