docs/latex/wx/activevt.tex

   1 \section{\class{wxActivateEvent}}\label{wxactivateevent}
   2
   3 An activate event is sent when a window or application is being activated
   4 or deactivated.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxEvent}{wxevent}\\
   9 \helpref{wxObject}{wxobject}
  10
  11 \wxheading{Include files}
  12
  13 <wx/event.h>
  14
  15 \wxheading{Event table macros}
  16
  17 To process an activate event, use these event handler macros to direct input to a member
  18 function that takes a wxActivateEvent argument.
  19
  20 \twocolwidtha{7cm}
  21 \begin{twocollist}\itemsep=0pt
  22 \twocolitem{{\bf EVT\_ACTIVATE(func)}}{Process a wxEVT\_ACTIVATE event.}
  23 \twocolitem{{\bf EVT\_ACTIVATE\_APP(func)}}{Process a wxEVT\_ACTIVATE\_APP event.}
  24 \twocolitem{{\bf EVT\_HIBERNATE(func)}}{Process a hibernate event, supplying the member function.
  25 This event applies to wxApp only, and only on Windows SmartPhone and PocketPC. It is generated when the
  26 system is low on memory; the application should free up as much memory as possible, and restore
  27 full working when it receives a wxEVT\_ACTIVATE or wxEVT\_ACTIVATE\_APP event.}
  28 \end{twocollist}%
  29
  30 \wxheading{Remarks}
  31
  32 A top-level window (a dialog or frame) receives an activate event when is
  33 being activated or deactivated. This is indicated visually by the title
  34 bar changing colour, and a subwindow gaining the keyboard focus.
  35
  36 An application is activated or deactivated when one of its frames becomes activated,
  37 or a frame becomes inactivate resulting in all application frames being inactive. (Windows only)
  38
  39 Please note that usually you should call \helpref{event.Skip()}{wxeventskip} in
  40 your handlers for these events as not doing so can result in strange effects.
  41
  42 \wxheading{See also}
  43
  44 \helpref{Event handling overview}{eventhandlingoverview},\rtfsp
  45 \helpref{wxApp::IsActive}{wxappisactive}
  46
  47 \latexignore{\rtfignore{\wxheading{Members}}}
  48
  49 \membersection{wxActivateEvent::wxActivateEvent}\label{wxactivateeventctor}
  50
  51 \func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = true}, \param{int }{id = 0}}
  52
  53 Constructor.
  54
  55 \membersection{wxActivateEvent::GetActive}\label{wxactivateeventgetactive}
  56
  57 \constfunc{bool}{GetActive}{\void}
  58
  59 Returns true if the application or window is being activated, false otherwise.
  60