X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1d2bd8475d56ae893f48aa5ca7676f0d9e72825a..dc484d491b15355285a89da275c58c2ef247d1f4:/docs/latex/wx/noteevt.tex diff --git a/docs/latex/wx/noteevt.tex b/docs/latex/wx/noteevt.tex index e1c9e7d476..04e0a26391 100644 --- a/docs/latex/wx/noteevt.tex +++ b/docs/latex/wx/noteevt.tex @@ -2,7 +2,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 +page is changed. It allows the program to examine the current page (which can be retrieved with \helpref{GetOldSelection()}{wxnotebookeventgetoldselection}) and to veto the page change by calling \helpref{Veto()}{wxnotifyeventveto} if, for example, the @@ -16,16 +16,11 @@ before allowing the user to change it, it should process the PAGE\_CHANGING event, otherwise PAGE\_CHANGED is probably enough. In any case, it is probably unnecessary to process both events at once. -{\bf NB:} under Windows, GetSelection() will return the same value as -GetOldSelection() when called from PAGE\_CHANGING handler and not the page -which is going to be selected if the handler doesn't call Veto(). - \wxheading{Derived from} \helpref{wxNotifyEvent}{wxnotifyevent}\\ \helpref{wxCommandEvent}{wxcommandevent}\\ \helpref{wxEvent}{wxevent}\\ -\helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} \wxheading{Include files} @@ -36,28 +31,42 @@ which is going to be selected if the handler doesn't call Veto(). \wxheading{See also} -\helpref{wxNotebook}{wxnotebook}, \helpref{wxTabCtrl}{wxtabctrl}, \helpref{wxTabEvent}{wxtabevent} +\helpref{wxNotebook}{wxnotebook} \latexignore{\rtfignore{\wxheading{Members}}} + \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 wxWidgets only). -Constructor (used internally by wxWindows only). \membersection{wxNotebookEvent::GetOldSelection}\label{wxnotebookeventgetoldselection} \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. Also note that the values of selection and old selection returned +for an event generated in response to a call to +\helpref{wxNotebook::SetSelection}{wxnotebooksetselection} shouldn't be trusted +as they are currently inconsistent under different platforms (but in this case +you presumably don't need them anyhow as you already have the corresponding +information). + \membersection{wxNotebookEvent::SetOldSelection}\label{wxnotebookeventsetoldselection} @@ -65,6 +74,7 @@ Returns the currently selected page, or -1 if none was selected. Sets the id of the page selected before the change. + \membersection{wxNotebookEvent::SetSelection}\label{wxnotebookeventsetselection} \func{void}{SetSelection}{\param{int}{ page}}