1d30a0a132
Restore the wxWizard wxEVT_WIZARD_FINISHED event, which was sent when the FINISHED button was pressed and the wizard was finished. When the wxWizard is modal this event is not needed. However, when the wizard is non-modal this is the only way to determine that the wizard has finished. Scott Pleiter git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18136 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
76 lines
2.6 KiB
TeX
76 lines
2.6 KiB
TeX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
%% Name: wizevt.tex
|
|
%% Purpose: wxWizardEvent class documentation
|
|
%% Author: Vadim Zeitlin
|
|
%% Modified by:
|
|
%% Created: 02.04.00
|
|
%% RCS-ID: $Id$
|
|
%% Copyright: (c) Vadim Zeitlin
|
|
%% License: wxWindows license
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
\section{\class{wxWizardEvent}}\label{wxwizardevent}
|
|
|
|
wxWizardEvent class represents an event generated by the
|
|
\helpref{wizard}{wxwizard}: this event is first sent to the page itself and,
|
|
if not processed there, goes up the window hierarchy as usual.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxNotifyEvent}{wxnotifyevent}\\
|
|
\helpref{wxCommandEvent}{wxcommandevent}\\
|
|
\helpref{wxEvent}{wxevent}\\
|
|
\helpref{wxObject}{wxobject}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/wizard.h>
|
|
|
|
\wxheading{Event table macros}
|
|
|
|
To process input from a wizard dialog, use these event handler macros to
|
|
direct input to member functions that take a wxWizardEvent argument.
|
|
|
|
\twocolwidtha{7cm}
|
|
\begin{twocollist}\itemsep=2pt
|
|
\twocolitem{{\bf EVT\_WIZARD\_PAGE\_CHANGED(id, func)}}{The page has been just
|
|
changed (this event can not be vetoed).}
|
|
\twocolitem{{\bf EVT\_WIZARD\_PAGE\_CHANGING(id, func)}}{The page is being
|
|
changed (this event can be vetoed).}
|
|
\twocolitem{{\bf EVT\_WIZARD\_CANCEL(id, func)}}{The user attempted to cancel
|
|
the wizard (this event may also be vetoed).}
|
|
\twocolitem{{\bf EVT\_WIZARD\_HELP(id, func)}}{The wizard help button was pressed.}
|
|
\twocolitem{{\bf EVT\_WIZARD\_FINISHED(id, func)}}{The wizard finished button was pressed.}
|
|
\end{twocollist}%
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxWizard}{wxwizard}, \helpref{wxWizard sample}{samplewizard}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxWizardEvent::wxWizardEvent}\label{wxwizardeventwxwizardevent}
|
|
|
|
\func{}{wxWizardEvent}{\param{wxEventType }{type = wxEVT\_NULL}, \param{int }{id = -1}, \param{bool }{direction = TRUE}}
|
|
|
|
Constructor. It is not normally used by the user code as the objects of this
|
|
type are constructed by wxWizard.
|
|
|
|
\membersection{wxWizardEvent::GetDirection}\label{wxwizardeventgetdirection}
|
|
|
|
\constfunc{bool}{GetDirection}{\void}
|
|
|
|
Return the direction in which the page is changing: for {\tt
|
|
EVT\_WIZARD\_PAGE\_CHANGING}, return {\tt TRUE} if we're going forward or
|
|
FALSE otherwise and for {\tt EVT\_WIZARD\_PAGE\_CHANGED} return {\tt TRUE} if
|
|
we came from the previous page and {\tt FALSE} if we returned from the next
|
|
one.
|
|
|
|
\membersection{wxWizardEvent::GetPage}\label{wxwizardeventgetpage}
|
|
|
|
\constfunc{wxWizardPage*}{GetPage}{\void}
|
|
|
|
Returns the \helpref{wxWizardPage}{wxwizardpage} which was active when this
|
|
event was generated.
|
|
|