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{Event table macros}
  13
  14 To process a notebook event, use these event handler macros to direct input to member
  15 functions that take a wxNotebookEvent argument.
  16
  17 \twocolwidtha{7cm}
  18 \begin{twocollist}\itemsep=0pt
  19 \twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGED(id, func)}}{The page selection was changed. Processes a
  20 wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED event.}
  21 \twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGING(id, func)}}{The page selection is about to be changed.
  22 Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.}
  23 \end{twocollist}%
  24
  25 \wxheading{See also}
  26
  27 \helpref{wxNotebook}{wxnotebook}, \helpref{wxTabCtrl}{wxtabctrl}, \helpref{wxTabEvent}{wxtabevent}
  28
  29 \latexignore{\rtfignore{\wxheading{Members}}}
  30
  31 \membersection{wxNotebookEvent::wxNotebookEvent}\label{wxnotebookeventconstr}
  32
  33 \func{}{wxNotebookEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
  34  \param{int}{ id = 0}, \param{int}{ sel = -1}, \param{int}{ oldSel = -1}}
  35
  36 Constructor.
  37
  38 \membersection{wxNotebookEvent::GetOldSelection}\label{wxnotebookeventgetoldselection}
  39
  40 \constfunc{int}{GetOldSelection}{\void}
  41
  42 Returns the page that was selected before the change, -1 if none was selected.
  43
  44 \membersection{wxNotebookEvent::GetSelection}\label{wxnotebookeventgetselection}
  45
  46 \constfunc{int}{GetSelection}{\void}
  47
  48 Returns the currently selected page, or -1 if none was selected.
  49
  50 \membersection{wxNotebookEvent::SetOldSelection}\label{wxnotebookeventsetoldselection}
  51
  52 \func{void}{SetOldSelection}{\param{int}{ page}}
  53
  54 Sets the id of the page selected before the change.
  55
  56 \membersection{wxNotebookEvent::SetSelection}\label{wxnotebookeventsetselection}
  57
  58 \func{void}{SetSelection}{\param{int}{ page}}
  59
  60 Sets the selection member variable.
  61
  62 \wxheading{See also}
  63
  64 \helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection}
  65
  66