docs/latex/wx/noteevt.tex

   1 \section{\class{wxNotebookEvent}}\label{wxnotebookevent}
   2
   3 This class represents the events generated by a notebook control.
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxCommandEvent}{wxcommandevent}\\
   8 \helpref{wxEvent}{wxevent}\\
   9 \helpref{wxEvtHandler}{wxevthandler}\\
  10 \helpref{wxObject}{wxobject}
  11
  12 \wxheading{Include files}
  13
  14 <wx/notebook.h>
  15
  16 \wxheading{Event table macros}
  17
  18 To process a notebook event, use these event handler macros to direct input to member
  19 functions that take a wxNotebookEvent argument.
  20
  21 \twocolwidtha{7cm}
  22 \begin{twocollist}\itemsep=0pt
  23 \twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGED(id, func)}}{The page selection was changed. Processes a
  24 wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED event.}
  25 \twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGING(id, func)}}{The page selection is about to be changed.
  26 Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.}
  27 \end{twocollist}%
  28
  29 \wxheading{See also}
  30
  31 \helpref{wxNotebook}{wxnotebook}, \helpref{wxTabCtrl}{wxtabctrl}, \helpref{wxTabEvent}{wxtabevent}
  32
  33 \latexignore{\rtfignore{\wxheading{Members}}}
  34
  35 \membersection{wxNotebookEvent::wxNotebookEvent}\label{wxnotebookeventconstr}
  36
  37 \func{}{wxNotebookEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
  38  \param{int}{ id = 0}, \param{int}{ sel = -1}, \param{int}{ oldSel = -1}}
  39
  40 Constructor.
  41
  42 \membersection{wxNotebookEvent::GetOldSelection}\label{wxnotebookeventgetoldselection}
  43
  44 \constfunc{int}{GetOldSelection}{\void}
  45
  46 Returns the page that was selected before the change, -1 if none was selected.
  47
  48 \membersection{wxNotebookEvent::GetSelection}\label{wxnotebookeventgetselection}
  49
  50 \constfunc{int}{GetSelection}{\void}
  51
  52 Returns the currently selected page, or -1 if none was selected.
  53
  54 \membersection{wxNotebookEvent::SetOldSelection}\label{wxnotebookeventsetoldselection}
  55
  56 \func{void}{SetOldSelection}{\param{int}{ page}}
  57
  58 Sets the id of the page selected before the change.
  59
  60 \membersection{wxNotebookEvent::SetSelection}\label{wxnotebookeventsetselection}
  61
  62 \func{void}{SetSelection}{\param{int}{ page}}
  63
  64 Sets the selection member variable.
  65
  66 \wxheading{See also}
  67
  68 \helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection}
  69
  70