[wxWidgets.git] / docs / latex / wx / activevt.tex

\section{\class{wxActivateEvent}}\label{wxactivateevent}

An activate event is sent when a window or application is being activated
or deactivated.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Event table macros}

To process an activate event, use these event handler macros to direct input to a member
function that takes a wxActivateEvent argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_ACTIVATE(func)}}{Process a wxEVT\_ACTIVATE event.}
\twocolitem{{\bf EVT\_ACTIVATE\_APP(func)}}{Process a wxEVT\_ACTIVATE\_APP event.}
\end{twocollist}%

\wxheading{Remarks}

A top-level window (a dialog or frame) receives an activate event when is
being activated or deactivated. This is indicated visually by the title
bar changing colour, and a subwindow gaining the keyboard focus.

An application is activated or deactivated when one of its frames becomes activated,
or a frame becomes inactivate resulting in all application frames being inactive. (Windows only)

\wxheading{See also}

\helpref{wxWindow::OnActivate}{wxwindowonactivate},\rtfsp
\helpref{wxApp::OnActivate}{wxapponactivate},\rtfsp
\helpref{Event handling overview}{eventhandlingoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxActivateEvent::wxActivateEvent}

\func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{int }{id = 0}}

Constructor.

\membersection{wxActivateEvent::m\_active}

\member{bool}{m\_active}

TRUE if the window or application was activated.

\membersection{wxActivateEvent::GetActive}\label{wxactivateeventgetactive}

\constfunc{bool}{GetActive}{\void}

Returns TRUE if the application or window is being activated, FALSE otherwise.
Commit	Line	Data
a660d684 KB	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{Event table macros}
	12
	13	To process an activate event, use these event handler macros to direct input to a member
	14	function that takes a wxActivateEvent argument.
	15
	16	\twocolwidtha{7cm}
	17	\begin{twocollist}\itemsep=0pt
	18	\twocolitem{{\bf EVT\_ACTIVATE(func)}}{Process a wxEVT\_ACTIVATE event.}
	19	\twocolitem{{\bf EVT\_ACTIVATE\_APP(func)}}{Process a wxEVT\_ACTIVATE\_APP event.}
	20	\end{twocollist}%
	21
	22	\wxheading{Remarks}
	23
	24	A top-level window (a dialog or frame) receives an activate event when is
	25	being activated or deactivated. This is indicated visually by the title
	26	bar changing colour, and a subwindow gaining the keyboard focus.
	27
	28	An application is activated or deactivated when one of its frames becomes activated,
	29	or a frame becomes inactivate resulting in all application frames being inactive. (Windows only)
	30
	31	\wxheading{See also}
	32
	33	\helpref{wxWindow::OnActivate}{wxwindowonactivate},\rtfsp
	34	\helpref{wxApp::OnActivate}{wxapponactivate},\rtfsp
	35	\helpref{Event handling overview}{eventhandlingoverview}
	36
	37	\latexignore{\rtfignore{\wxheading{Members}}}
	38
	39	\membersection{wxActivateEvent::wxActivateEvent}
	40
	41	\func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{int }{id = 0}}
	42
	43	Constructor.
	44
	45	\membersection{wxActivateEvent::m\_active}
	46
	47	\member{bool}{m\_active}
	48
	49	TRUE if the window or application was activated.
	50
	51	\membersection{wxActivateEvent::GetActive}\label{wxactivateeventgetactive}
	52
	53	\constfunc{bool}{GetActive}{\void}
	54
	55	Returns TRUE if the application or window is being activated, FALSE otherwise.
	56