X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..3f16e52c1396f7d58b29b2eea22d7715f0f4596b:/interface/power.h

diff --git a/interface/power.h b/interface/power.h
index 316db2115f..b54808f562 100644
--- a/interface/power.h
+++ b/interface/power.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        power.h
-// Purpose:     documentation for wxPowerEvent class
+// Purpose:     interface of wxPowerEvent
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,30 +9,46 @@
 /**
     @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 @c ifdef wxHAS_POWER_EVENTS instead of directly testing for
+    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{FIXME}
-    
-    @seealso
-    wxGetPowerType, wxGetBatteryState
+    @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).
+        Call this to prevent suspend from taking place in @c wxEVT_POWER_SUSPENDING
+        handler (it is ignored for all the others).
     */
     void Veto();
 };
+