]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/noteevt.tex
no changes, just come cleanup and more comments
[wxWidgets.git] / docs / latex / wx / noteevt.tex
index 51bc22e9feb0a2707b1b24aaee88e52775a7f92a..5c78151e8a42740c5d0ef4654c5818b8610193b7 100644 (file)
@@ -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
@@ -27,20 +27,26 @@ unnecessary to process both events at once.
 
 <wx/notebook.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \input noteevt.inc
 
 \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$}}
 
-Constructor (used internally by wxWindows only).
+Constructor (used internally by wxWidgets only).
+
 
 \membersection{wxNotebookEvent::GetOldSelection}\label{wxnotebookeventgetoldselection}
 
@@ -48,6 +54,7 @@ Constructor (used internally by wxWindows only).
 
 Returns the page that was selected before the change, $-1$ if none was selected.
 
+
 \membersection{wxNotebookEvent::GetSelection}\label{wxnotebookeventgetselection}
 
 \constfunc{int}{GetSelection}{\void}
@@ -57,7 +64,13 @@ 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.
+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 +78,7 @@ be selected.
 
 Sets the id of the page selected before the change.
 
+
 \membersection{wxNotebookEvent::SetSelection}\label{wxnotebookeventsetselection}
 
 \func{void}{SetSelection}{\param{int}{ page}}