]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/notebook.tex
added/documented wxApp::FilterEvent
[wxWidgets.git] / docs / latex / wx / notebook.tex
index 2ec54d1b11eb8080c3039a5eb15d098d181afe8b..a35d4dd3f682c4a3b84c58d50dcbeaf9b3e878e6 100644 (file)
@@ -33,18 +33,7 @@ managed by wxNotebook.
 
 See also \helpref{window styles overview}{windowstyles}.
 
-
-\wxheading{Event handling}
-
-To process input from a notebook control, use the following event handler macros to direct input to member
-functions that take a \helpref{wxNotebookEvent}{wxnotebookevent} argument.
-
-\twocolwidtha{7cm}
-\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGED(id, func)}}{The page selection was changed.}
-\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGING(id, func)}}{The page selection is about to be changed.
-This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
-\end{twocollist}%
+\input noteevt.inc
 
 \wxheading{See also}
 
@@ -60,7 +49,7 @@ This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
 Default constructor.
 
 \func{}{wxNotebook}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
- \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}}
+ \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}}
 
 Constructs a notebook control.
 
@@ -123,6 +112,18 @@ Do not delete the page, it will be deleted by the notebook.
 
 Cycles through the tabs.
 
+\membersection{wxNotebook::AssignImageList}\label{wxnotebookassignimagelist}
+
+\func{void}{AssignImageList}{\param{wxImageList*}{ imageList}}
+
+Sets the image list for the page control and takes ownership of
+the list.
+
+\wxheading{See also}
+
+\helpref{wxImageList}{wximagelist},
+\helpref{SetImageList}{wxnotebooksetimagelist}
+
 \membersection{wxNotebook::Create}\label{wxnotebookcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
@@ -187,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}
 
@@ -242,11 +249,13 @@ Deletes the specified page, without deleting the associated window.
 
 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
 
-Sets the image list for the page control.
+Sets the image list for the page control. It does not take
+ownership of the image list, you must delete it yourself.
 
 \wxheading{See also}
 
-\helpref{wxImageList}{wximagelist}
+\helpref{wxImageList}{wximagelist},
+\helpref{AssignImageList}{wxnotebookassignimagelist}
 
 \membersection{wxNotebook::SetPadding}\label{wxnotebooksetpadding}