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{Library}
  28
  29 \helpref{wxCore}{librarieslist}
  30
  31 \wxheading{Event table macros}
  32
  33 To process an iconize event, use this event handler macro to direct input to a
  34 member function that takes a wxIconizeEvent argument.
  35
  36 \twocolwidtha{7cm}
  37 \begin{twocollist}\itemsep=0pt
  38 \twocolitem{{\bf EVT\_ICONIZE(func)}}{Process a wxEVT\_ICONIZE event.}
  39 \end{twocollist}%
  40
  41 \wxheading{See also}
  42
  43 \helpref{Event handling overview}{eventhandlingoverview},\rtfsp
  44 \helpref{wxTopLevelWindow::Iconize}{wxtoplevelwindowiconize},\rtfsp
  45 \helpref{wxTopLevelWindow::IsIconized}{wxtoplevelwindowisiconized}
  46
  47 \latexignore{\rtfignore{\wxheading{Members}}}
  48
  49 \membersection{wxIconizeEvent::wxIconizeEvent}\label{wxiconizeeventctor}
  50
  51 \func{}{wxIconizeEvent}{\param{int }{id = 0}, \param{bool }{iconized = true}}
  52
  53 Constructor.
  54
  55 \membersection{wxIconizeEvent::Iconized}\label{wxiconizeeventiconized}
  56
  57 \constfunc{bool}{Iconized}{\void}
  58
  59 Returns {\tt true} if the frame has been iconized, {\tt false} if it has been
  60 restored.
  61