docs/latex/wx/wizevt.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        wizevt.tex
   3 %% Purpose:     wxWizardEvent class documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Modified by:
   6 %% Created:     02.04.00
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) Vadim Zeitlin
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxWizardEvent}}\label{wxwizardevent}
  13
  14 wxWizardEvent class represents an event generated by the
  15 \helpref{wizard}{wxwizard}: this event is first sent to the page itself and,
  16 if not processed there, goes up the window hierarchy as usual.
  17
  18 \wxheading{Derived from}
  19
  20 \helpref{wxNotifyEvent}{wxnotifyevent}\\
  21 \helpref{wxCommandEvent}{wxcommandevent}\\
  22 \helpref{wxEvent}{wxevent}\\
  23 \helpref{wxObject}{wxobject}
  24
  25 \wxheading{Include files}
  26
  27 <wx/wizard.h>
  28
  29 \wxheading{Event table macros}
  30
  31 To process input from a wizard dialog, use these event handler macros to
  32 direct input to member functions that take a wxWizardEvent argument.
  33
  34 \twocolwidtha{7cm}
  35 \begin{twocollist}\itemsep=2pt
  36 \twocolitem{{\bf EVT\_WIZARD\_PAGE\_CHANGED(id, func)}}{The page has been just
  37 changed (this event can not be vetoed).}
  38 \twocolitem{{\bf EVT\_WIZARD\_PAGE\_CHANGING(id, func)}}{The page is being
  39 changed (this event can be vetoed).}
  40 \twocolitem{{\bf EVT\_WIZARD\_CANCEL(id, func)}}{The user attempted to cancel
  41 the wizard (this event may also be vetoed).}
  42 \twocolitem{{\bf EVT\_WIZARD\_HELP(id, func)}}{The wizard help button was pressed.}
  43 \end{twocollist}%
  44
  45 \wxheading{See also}
  46
  47 \helpref{wxWizard}{wxwizard}, \helpref{wxWizard sample}{samplewizard}
  48
  49 \latexignore{\rtfignore{\wxheading{Members}}}
  50
  51 \membersection{wxWizardEvent::wxWizardEvent}\label{wxwizardeventwxwizardevent}
  52
  53 \func{}{wxWizardEvent}{\param{wxEventType }{type = wxEVT\_NULL}, \param{int }{id = -1}, \param{bool }{direction = TRUE}}
  54
  55 Constructor. It is not normally used by the user code as the objects of this
  56 type are constructed by wxWizard.
  57
  58 \membersection{wxWizardEvent::GetDirection}\label{wxwizardeventgetdirection}
  59
  60 \constfunc{bool}{GetDirection}{\void}
  61
  62 Return the direction in which the page is changing: for {\tt
  63 EVT\_WIZARD\_PAGE\_CHANGING}, return {\tt TRUE} if we're going forward or
  64 FALSE otherwise and for {\tt EVT\_WIZARD\_PAGE\_CHANGED} return {\tt TRUE} if
  65 we came from the previous page and {\tt FALSE} if we returned from the next
  66 one.
  67
  68 \membersection{wxWizardEvent::GetPage}\label{wxwizardeventgetpage}
  69
  70 \constfunc{wxWizardPage}{GetPage}{\void}
  71
  72 Returns the \helpref{wxWizardPage}{wxwizardpage} which was active when this
  73 event was generated.
  74