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 \end{twocollist}%
  25
  26 \wxheading{Remarks}
  27
  28 A top-level window (a dialog or frame) receives an activate event when is
  29 being activated or deactivated. This is indicated visually by the title
  30 bar changing colour, and a subwindow gaining the keyboard focus.
  31
  32 An application is activated or deactivated when one of its frames becomes activated,
  33 or a frame becomes inactivate resulting in all application frames being inactive. (Windows only)
  34
  35 Please note that usually you should call \helpref{event.Skip()}{wxeventskip} in
  36 your handlers for these events as not doing so can result in strange effects,
  37 especially on Mac platform.
  38
  39 \wxheading{See also}
  40
  41 \helpref{Event handling overview}{eventhandlingoverview},\rtfsp
  42 \helpref{wxApp::IsActive}{wxappisactive}
  43
  44 \latexignore{\rtfignore{\wxheading{Members}}}
  45
  46 \membersection{wxActivateEvent::wxActivateEvent}\label{wxactivateeventctor}
  47
  48 \func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = true}, \param{int }{id = 0}}
  49
  50 Constructor.
  51
  52 \membersection{wxActivateEvent::GetActive}\label{wxactivateeventgetactive}
  53
  54 \constfunc{bool}{GetActive}{\void}
  55
  56 Returns true if the application or window is being activated, false otherwise.
  57