]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/iconevt.tex
Typo correction
[wxWidgets.git] / docs / latex / wx / iconevt.tex
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %% Name: iconevt.tex
3 %% Purpose: wxIconizeEvent documentation
4 %% Author: Vadim Zeitlin
5 %% Modified by:
6 %% Created:
7 %% RCS-ID: $Id$
8 %% Copyright: (c) 2001 Vadim Zeitlin
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12 \section{\class{wxIconizeEvent}}\label{wxiconizeevent}
13
14 An event being sent when the frame is iconized (minimized) or restored.
15
16 Currently only wxMSW and wxGTK generate such events.
17
18 \wxheading{Derived from}
19
20 \helpref{wxEvent}{wxevent}\\
21 \helpref{wxObject}{wxobject}
22
23 \wxheading{Include files}
24
25 <wx/event.h>
26
27 \wxheading{Event table macros}
28
29 To process an iconize event, use this event handler macro to direct input to a
30 member function that takes a wxIconizeEvent argument.
31
32 \twocolwidtha{7cm}
33 \begin{twocollist}\itemsep=0pt
34 \twocolitem{{\bf EVT\_ICONIZE(func)}}{Process a wxEVT\_ICONIZE event.}
35 \end{twocollist}%
36
37 \wxheading{See also}
38
39 \helpref{Event handling overview}{eventhandlingoverview},\rtfsp
40 \helpref{wxTopLevelWindow::Iconize}{wxtoplevelwindowiconize},\rtfsp
41 \helpref{wxTopLevelWindow::IsIconized}{wxtoplevelwindowisiconized}
42
43 \latexignore{\rtfignore{\wxheading{Members}}}
44
45 \membersection{wxIconizeEvent::wxIconizeEvent}\label{wxiconizeeventctor}
46
47 \func{}{wxIconizeEvent}{\param{int }{id = 0}, \param{bool }{iconized = true}}
48
49 Constructor.
50
51 \membersection{wxIconizeEvent::Iconized}\label{wxiconizeeventiconized}
52
53 \constfunc{bool}{Iconized}{\void}
54
55 Returns {\tt true} if the frame has been iconized, {\tt false} if it has been
56 restored.
57