interface/power.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        power.h
   3 // Purpose:     interface of wxPowerEvent
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxPowerEvent
  11     @wxheader{power.h}
  12
  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.
  16
  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.
  23
  24     @library{wxbase}
  25     @category{FIXME}
  26
  27     @see wxGetPowerType(), wxGetBatteryState()
  28 */
  29 class wxPowerEvent : public wxEvent
  30 {
  31 public:
  32     /**
  33         Call this to prevent suspend from taking place in
  34         @c wxEVT_POWER_SUSPENDING handler (it is ignored for all the others).
  35     */
  36     void Veto();
  37 };
  38