projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| f6bcfd97 BP |
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 | |
| 8795498c | 9 | %% License: wxWindows license |
| f6bcfd97 BP |
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 | ||
| a7af285d VZ |
29 | \wxheading{Library} |
| 30 | ||
| 31 | \helpref{wxAdv}{librarieslist} | |
| 32 | ||
| f6bcfd97 BP |
33 | \wxheading{Event table macros} |
| 34 | ||
| 35 | To process input from a wizard dialog, use these event handler macros to | |
| 36 | direct input to member functions that take a wxWizardEvent argument. | |
| 37 | ||
| 38 | \twocolwidtha{7cm} | |
| 39 | \begin{twocollist}\itemsep=2pt | |
| 40 | \twocolitem{{\bf EVT\_WIZARD\_PAGE\_CHANGED(id, func)}}{The page has been just | |
| 41 | changed (this event can not be vetoed).} | |
| 42 | \twocolitem{{\bf EVT\_WIZARD\_PAGE\_CHANGING(id, func)}}{The page is being | |
| 43 | changed (this event can be vetoed).} | |
| 44 | \twocolitem{{\bf EVT\_WIZARD\_CANCEL(id, func)}}{The user attempted to cancel | |
| 45 | the wizard (this event may also be vetoed).} | |
| f80bf901 | 46 | \twocolitem{{\bf EVT\_WIZARD\_HELP(id, func)}}{The wizard help button was pressed.} |
| 1d30a0a1 | 47 | \twocolitem{{\bf EVT\_WIZARD\_FINISHED(id, func)}}{The wizard finished button was pressed.} |
| d2c2afc9 | 48 | \end{twocollist} |
| f6bcfd97 BP |
49 | |
| 50 | \wxheading{See also} | |
| 51 | ||
| 52 | \helpref{wxWizard}{wxwizard}, \helpref{wxWizard sample}{samplewizard} | |
| 53 | ||
| 54 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 55 | ||
| 56 | \membersection{wxWizardEvent::wxWizardEvent}\label{wxwizardeventwxwizardevent} | |
| 57 | ||
| cc81d32f | 58 | \func{}{wxWizardEvent}{\param{wxEventType }{type = wxEVT\_NULL}, \param{int }{id = -1}, \param{bool }{direction = true}} |
| f6bcfd97 BP |
59 | |
| 60 | Constructor. It is not normally used by the user code as the objects of this | |
| 61 | type are constructed by wxWizard. | |
| 62 | ||
| 63 | \membersection{wxWizardEvent::GetDirection}\label{wxwizardeventgetdirection} | |
| 64 | ||
| 65 | \constfunc{bool}{GetDirection}{\void} | |
| 66 | ||
| 67 | Return the direction in which the page is changing: for {\tt | |
| cc81d32f VS |
68 | EVT\_WIZARD\_PAGE\_CHANGING}, return {\tt true} if we're going forward or |
| 69 | false otherwise and for {\tt EVT\_WIZARD\_PAGE\_CHANGED} return {\tt true} if | |
| 70 | we came from the previous page and {\tt false} if we returned from the next | |
| f6bcfd97 BP |
71 | one. |
| 72 | ||
| f80bf901 VZ |
73 | \membersection{wxWizardEvent::GetPage}\label{wxwizardeventgetpage} |
| 74 | ||
| 298fe32f | 75 | \constfunc{wxWizardPage*}{GetPage}{\void} |
| f80bf901 VZ |
76 | |
| 77 | Returns the \helpref{wxWizardPage}{wxwizardpage} which was active when this | |
| 78 | event was generated. | |
| 79 |