]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/activevt.tex
correction for Mac OS compilation
[wxWidgets.git] / 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 \wxheading{See also}
36
37 \helpref{wxWindow::OnActivate}{wxwindowonactivate},\rtfsp
38 \helpref{wxApp::OnActivate}{wxapponactivate},\rtfsp
39 \helpref{Event handling overview}{eventhandlingoverview}
40
41 \latexignore{\rtfignore{\wxheading{Members}}}
42
43 \membersection{wxActivateEvent::wxActivateEvent}
44
45 \func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = TRUE}, \param{int }{id = 0}}
46
47 Constructor.
48
49 \membersection{wxActivateEvent::m\_active}
50
51 \member{bool}{m\_active}
52
53 TRUE if the window or application was activated.
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