docs/latex/wx/sizeevt.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        sizeevt.tex
   3 %% Purpose:     wxSizeEvent and related event classes documentation
   4 %% Author:      wxWindows team
   5 %% Modified by:
   6 %% Created:
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) wxWindows team
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  13 %% wxSizeEvent
  14 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  15
  16 \section{\class{wxSizeEvent}}\label{wxsizeevent}
  17
  18 A size event holds information about size change events.
  19
  20 \wxheading{Derived from}
  21
  22 \helpref{wxEvent}{wxevent}\\
  23 \helpref{wxObject}{wxobject}
  24
  25 \wxheading{Include files}
  26
  27 <wx/event.h>
  28
  29 \wxheading{Event table macros}
  30
  31 To process a size event, use this event handler macro to direct input to a member
  32 function that takes a wxSizeEvent argument.
  33
  34 \twocolwidtha{7cm}
  35 \begin{twocollist}\itemsep=0pt
  36 \twocolitem{{\bf EVT\_SIZE(func)}}{Process a wxEVT\_SIZE event.}
  37 \end{twocollist}%
  38
  39 \wxheading{See also}
  40
  41 \helpref{wxSize}{wxsize},\rtfsp
  42 \helpref{Event handling overview}{eventhandlingoverview}
  43
  44 \latexignore{\rtfignore{\wxheading{Members}}}
  45
  46 \membersection{wxSizeEvent::wxSizeEvent}
  47
  48 \func{}{wxSizeEvent}{\param{const wxSize\& }{sz}, \param{int }{id = 0}}
  49
  50 Constructor.
  51
  52 \membersection{wxSizeEvent::GetSize}\label{wxsizeeventgetsize}
  53
  54 \constfunc{wxSize}{GetSize}{\void}
  55
  56 Returns the entire size of the window generating the size change event.
  57
  58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  59 %% wxIconizeEvent
  60 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  61
  62 \section{\class{wxIconizeEvent}}\label{wxiconizeevent}
  63
  64 An event being sent when the frame is iconized (minimized) or restored.
  65
  66 Currently only wxMSW and wxGTK generate such events.
  67
  68 \wxheading{Derived from}
  69
  70 \helpref{wxEvent}{wxevent}\\
  71 \helpref{wxObject}{wxobject}
  72
  73 \wxheading{Include files}
  74
  75 <wx/event.h>
  76
  77 \wxheading{Event table macros}
  78
  79 To process an iconize event, use this event handler macro to direct input to a
  80 member function that takes a wxIconizeEvent argument.
  81
  82 \twocolwidtha{7cm}
  83 \begin{twocollist}\itemsep=0pt
  84 \twocolitem{{\bf EVT\_ICONIZE(func)}}{Process a wxEVT\_ICONIZE event.}
  85 \end{twocollist}%
  86
  87 \wxheading{See also}
  88
  89 \helpref{Event handling overview}{eventhandlingoverview},\rtfsp
  90 \helpref{wxFrame::Iconize}{wxframeiconize},\rtfsp
  91 \helpref{wxFrame::IsIconized}{wxframeisiconized}
  92
  93 \latexignore{\rtfignore{\wxheading{Members}}}
  94
  95 \membersection{wxIconizeEvent::wxIconizeEvent}\label{wxiconizeeventctor}
  96
  97 \func{}{wxIconizeEvent}{\param{int }{id = 0}, \param{bool }{iconized = TRUE}}
  98
  99 Constructor.
 100
 101 \membersection{wxIconizeEvent::Iconized}\label{wxiconizeeventiconized}
 102
 103 \constfunc{bool}{Iconized}{\void}
 104
 105 Returns {\tt TRUE} if the frame has been iconized, {\tt FALSE} if it has been
 106 restored.
 107
 108 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 109 %% wxMaximizeEvent
 110 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 111
 112 \section{\class{wxMaximizeEvent}}\label{wxmaximizeevent}
 113
 114 An event being sent when the frame is maximized (minimized) or restored.
 115
 116 \wxheading{Derived from}
 117
 118 \helpref{wxEvent}{wxevent}\\
 119 \helpref{wxObject}{wxobject}
 120
 121 \wxheading{Include files}
 122
 123 <wx/event.h>
 124
 125 \wxheading{Event table macros}
 126
 127 To process a maximize event, use this event handler macro to direct input to a
 128 member function that takes a wxMaximizeEvent argument.
 129
 130 \twocolwidtha{7cm}
 131 \begin{twocollist}\itemsep=0pt
 132 \twocolitem{{\bf EVT\_MAXIMIZE(func)}}{Process a wxEVT\_MAXIMIZE event.}
 133 \end{twocollist}%
 134
 135 \wxheading{See also}
 136
 137 \helpref{Event handling overview}{eventhandlingoverview},\rtfsp
 138 \helpref{wxFrame::Maximize}{wxframemaximize},\rtfsp
 139 \helpref{wxFrame::IsMaximized}{wxframeismaximized}
 140
 141 \latexignore{\rtfignore{\wxheading{Members}}}
 142
 143 \membersection{wxMaximizeEvent::wxMaximizeEvent}\label{wxmaximizeeventctor}
 144
 145 \func{}{wxMaximizeEvent}{\param{int }{id = 0}}
 146
 147 Constructor.
 148