corrected EVT_NOTIFY[_RANGE] docs (bug 1439078)

[wxWidgets.git] / docs / latex / wx / noteevt.tex

diff --git a/docs/latex/wx/noteevt.tex b/docs/latex/wx/noteevt.tex
index 4fcc6816d6088c28b1f37799906c43a0d86881e6..04e0a26391b654e3e44290cdb7e2c16775f96aa2 100644 (file)
--- a/docs/latex/wx/noteevt.tex
+++ b/docs/latex/wx/noteevt.tex
@@ -2,9 +2,9 @@
 
 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
 
 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 
 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.
 
 change by calling \helpref{Veto()}{wxnotifyeventveto} if, for example, the
 current values in the controls of the old page are invalid.
 


@@ -21,50 +21,52 @@ unnecessary to process both events at once.
 \helpref{wxNotifyEvent}{wxnotifyevent}\\
 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxNotifyEvent}{wxnotifyevent}\\
 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\

-\helpref{wxEvtHandler}{wxevthandler}\\

 \helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/notebook.h>
 
 \helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/notebook.h>
 

-\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. This event can be \helpref{vetoed}{wxnotifyeventveto}.}
-\end{twocollist}%
+\input noteevt.inc

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxNotebook}{wxnotebook}, \helpref{wxTabCtrl}{wxtabctrl}, \helpref{wxTabEvent}{wxtabevent}
+\helpref{wxNotebook}{wxnotebook}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxNotebookEvent::wxNotebookEvent}\label{wxnotebookeventconstr}
 
 \func{}{wxNotebookEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \membersection{wxNotebookEvent::SetOldSelection}\label{wxnotebookeventsetoldselection}
 


@@ -72,6 +74,7 @@ Returns the currently selected page, or -1 if none was selected.
 
 Sets the id of the page selected before the change.
 
 
 Sets the id of the page selected before the change.
 

+

 \membersection{wxNotebookEvent::SetSelection}\label{wxnotebookeventsetselection}
 
 \func{void}{SetSelection}{\param{int}{ page}}
 \membersection{wxNotebookEvent::SetSelection}\label{wxnotebookeventsetselection}
 
 \func{void}{SetSelection}{\param{int}{ page}}