X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4d0f3cd6ac9b38521b35f21cb94ef7d72aa34b9e..9154d8cfff9f6a58ccec94bf242086e7e10ea91b:/docs/latex/wx/noteevt.tex diff --git a/docs/latex/wx/noteevt.tex b/docs/latex/wx/noteevt.tex index 3f557d1096..51bc22e9fe 100644 --- a/docs/latex/wx/noteevt.tex +++ b/docs/latex/wx/noteevt.tex @@ -4,7 +4,7 @@ This class represents the events generated by a notebook control: currently, there are two of them. The PAGE\_CHANGING event is sent before the current page is changed. It allows to the program to examine the current page (which can be retrieved with -\helpref{GetOldSelection()}wxnotebookeventgetoldselection}) and to veto the page +\helpref{GetOldSelection()}{wxnotebookeventgetoldselection}) and to veto the page change by calling \helpref{Veto()}{wxnotifyeventveto} if, for example, the current values in the controls of the old page are invalid. @@ -21,25 +21,13 @@ unnecessary to process both events at once. \helpref{wxNotifyEvent}{wxnotifyevent}\\ \helpref{wxCommandEvent}{wxcommandevent}\\ \helpref{wxEvent}{wxevent}\\ -\helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} \wxheading{Include files} -\wxheading{Event table macros} - -To process a notebook event, use these event handler macros to direct input to member -functions that take a wxNotebookEvent argument. - -\twocolwidtha{7cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGED(id, func)}}{The page selection was changed. Processes a -wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED event.} -\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGING(id, func)}}{The page selection is about to be changed. -Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.} -\end{twocollist}% +\input noteevt.inc \wxheading{See also} @@ -50,7 +38,7 @@ Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.} \membersection{wxNotebookEvent::wxNotebookEvent}\label{wxnotebookeventconstr} \func{}{wxNotebookEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL}, - \param{int}{ id = 0}, \param{int}{ sel = -1}, \param{int}{ oldSel = -1}} + \param{int}{ id = 0}, \param{int}{ sel = $-1$}, \param{int}{ oldSel = $-1$}} Constructor (used internally by wxWindows only). @@ -58,13 +46,18 @@ Constructor (used internally by wxWindows only). \constfunc{int}{GetOldSelection}{\void} -Returns the page that was selected before the change, -1 if none was selected. +Returns the page that was selected before the change, $-1$ if none was selected. \membersection{wxNotebookEvent::GetSelection}\label{wxnotebookeventgetselection} \constfunc{int}{GetSelection}{\void} -Returns the currently selected page, or -1 if none was selected. +Returns the currently selected page, or $-1$ if none was selected. + +{\bf NB:} under Windows, GetSelection() will return the same value as\rtfsp +\helpref{GetOldSelection()}{wxnotebookeventgetoldselection} when called from +{\tt EVT\_NOTEBOOK\_PAGE\_CHANGING} handler and not the page which is going to +be selected. \membersection{wxNotebookEvent::SetOldSelection}\label{wxnotebookeventsetoldselection}