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: wizevt.tex 63262 2010-01-25 18:47:47Z JS $ 8%% Copyright: (c) Vadim Zeitlin 9%% License: wxWindows license 10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 11 12\section{\class{wxWizardEvent}}\label{wxwizardevent} 13 14wxWizardEvent class represents an event generated by the 15\helpref{wizard}{wxwizard}: this event is first sent to the page itself and, 16if 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 31To process input from a wizard dialog, use these event handler macros to 32direct 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 37changed (this event can not be vetoed).} 38\twocolitem{{\bf EVT\_WIZARD\_PAGE\_CHANGING(id, func)}}{The page is being 39changed (this event can be vetoed).} 40\twocolitem{{\bf EVT\_WIZARD\_PAGE\_SHOWN(id, func)}}{The page was shown and laid out.} 41\twocolitem{{\bf EVT\_WIZARD\_CANCEL(id, func)}}{The user attempted to cancel 42the wizard (this event may also be vetoed).} 43\twocolitem{{\bf EVT\_WIZARD\_HELP(id, func)}}{The wizard help button was pressed.} 44\twocolitem{{\bf EVT\_WIZARD\_FINISHED(id, func)}}{The wizard finished button was pressed.} 45\end{twocollist} 46 47\wxheading{See also} 48 49\helpref{wxWizard}{wxwizard}, \helpref{wxWizard sample}{samplewizard} 50 51\latexignore{\rtfignore{\wxheading{Members}}} 52 53\membersection{wxWizardEvent::wxWizardEvent}\label{wxwizardeventwxwizardevent} 54 55\func{}{wxWizardEvent}{\param{wxEventType }{type = wxEVT\_NULL}, \param{int }{id = -1}, \param{bool }{direction = true}} 56 57Constructor. It is not normally used by the user code as the objects of this 58type are constructed by wxWizard. 59 60\membersection{wxWizardEvent::GetDirection}\label{wxwizardeventgetdirection} 61 62\constfunc{bool}{GetDirection}{\void} 63 64Return the direction in which the page is changing: for {\tt 65EVT\_WIZARD\_PAGE\_CHANGING}, return {\tt true} if we're going forward or 66false otherwise and for {\tt EVT\_WIZARD\_PAGE\_CHANGED} return {\tt true} if 67we came from the previous page and {\tt false} if we returned from the next 68one. 69 70\membersection{wxWizardEvent::GetPage}\label{wxwizardeventgetpage} 71 72\constfunc{wxWizardPage*}{GetPage}{\void} 73 74Returns the \helpref{wxWizardPage}{wxwizardpage} which was active when this 75event was generated. 76 77