minor updates/clarifications to the wxNotebook docs

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

diff --git a/docs/latex/wx/noteevt.tex b/docs/latex/wx/noteevt.tex
index 3c1f9bb8bf96ca2f0748726997682deebec8add7..705a3676dcc9886ef79f242f386f954fff98163c 100644 (file)
--- 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 
 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.
 
 change by calling \helpref{Veto()}{wxnotifyeventveto} if, for example, the
 current values in the controls of the old page are invalid.
 


@@ -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.
 
 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}\\
 \wxheading{Derived from}
 
 \helpref{wxNotifyEvent}{wxnotifyevent}\\


@@ -32,18 +28,7 @@ which is going to be selected if the handler doesn't call Veto().
 
 <wx/notebook.h>
 
 
 <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}
 


@@ -54,7 +39,7 @@ Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event. This event can be \h
 \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 wxWindows only).
 
 
 Constructor (used internally by wxWindows only).
 


@@ -62,13 +47,18 @@ Constructor (used internally by wxWindows only).
 
 \constfunc{int}{GetOldSelection}{\void}
 
 
 \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.

 
 \membersection{wxNotebookEvent::SetOldSelection}\label{wxnotebookeventsetoldselection}
 
 
 \membersection{wxNotebookEvent::SetOldSelection}\label{wxnotebookeventsetoldselection}