From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sun, 25 Nov 2001 15:32:16 +0000 (+0000)
Subject: minor updates/clarifications to the wxNotebook docs
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/f0125ede4ad4bb914d859d15510f64f88d8ce407

minor updates/clarifications to the wxNotebook docs


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@12686 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex
index 0e7c925e66..dde3ca1a67 100644
--- a/docs/latex/wx/notebook.tex
+++ b/docs/latex/wx/notebook.tex
@@ -188,7 +188,13 @@ Returns the number of rows in the notebook control.
 
 \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.
+
+Note that this method may return either the previously or newly selected page
+when called from the {\tt EVT\_NOTEBOOK\_PAGE\_CHANGED} handler depending on
+the platform and so\rtfsp
+\helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection} should be
+used instead in this case.
 
 \membersection{wxNotebook::InsertPage}\label{wxnotebookinsertpage}
 
diff --git a/docs/latex/wx/noteevt.tex b/docs/latex/wx/noteevt.tex
index e1c9e7d476..705a3676dc 100644
--- a/docs/latex/wx/noteevt.tex
+++ b/docs/latex/wx/noteevt.tex
@@ -16,10 +16,6 @@ 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}\\
@@ -43,7 +39,7 @@ which is going to be selected if the handler doesn't call Veto().
 \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).
 
@@ -51,13 +47,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}