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