Small corrections -- please remember to put a blank line at the end of each input...

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

diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex
index 1817f10652d1ba0607099125eb6454616ccb9623..dde3ca1a67ae0d2108ed8e543cb9f83865d3dd3f 100644 (file)
--- a/docs/latex/wx/notebook.tex
+++ b/docs/latex/wx/notebook.tex
@@ -15,18 +15,25 @@ managed by wxNotebook.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

-\wxheading{Event handling}
+\wxheading{Include files}

 
 

-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.
+<wx/notebook.h>

 
 

-\twocolwidtha{7cm}
+\wxheading{Window styles}
+
+\twocolwidtha{5cm}

 \begin{twocollist}\itemsep=0pt
 \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.}
-\end{twocollist}%
+
+\twocolitem{\windowstyle{wxNB\_FIXEDWIDTH}}{(Windows only)All tabs will have same width.}
+\twocolitem{\windowstyle{wxNB\_LEFT}}{Place tabs on the left side.}
+\twocolitem{\windowstyle{wxNB\_RIGHT}}{Place tabs on the right side.}
+\twocolitem{\windowstyle{wxNB\_BOTTOM}}{Place tabs under instead of above the notebook pages.}
+
+\end{twocollist}
+
+See also \helpref{window styles overview}{windowstyles}.
+
+\input noteevt.inc

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


@@ -46,6 +53,8 @@ Default constructor.
 
 Constructs a notebook control.
 
 
 Constructs a notebook control.
 

+Note that sometimes you can reduce flicker by passing the wxCLIP\_CHILDREN window style.
+

 \wxheading{Parameters}
 
 \docparam{parent}{The parent window. Must be non-NULL.}
 \wxheading{Parameters}
 
 \docparam{parent}{The parent window. Must be non-NULL.}


@@ -56,8 +65,9 @@ Constructs a notebook control.
 
 \docparam{size}{The window size.}
 
 
 \docparam{size}{The window size.}
 

-\docparam{style}{The window style. Its value is a bit list of zero or more of {\bf wxTC\_MULTILINE},
- {\bf wxTC\_RIGHTJUSTIFY}, {\bf wxTC\_FIXEDWIDTH} and {\bf wxTC\_OWNERDRAW}.}
+\docparam{style}{The window style. See \helpref{wxNotebook}{wxnotebook}.}
+
+\docparam{name}{The name of the control (used only under Motif).}

 
 \membersection{wxNotebook::\destruct{wxNotebook}}
 
 
 \membersection{wxNotebook::\destruct{wxNotebook}}
 


@@ -102,6 +112,18 @@ Do not delete the page, it will be deleted by the notebook.
 
 Cycles through the tabs.
 
 
 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},
 \membersection{wxNotebook::Create}\label{wxnotebookcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},


@@ -120,7 +142,7 @@ Deletes all pages.
 
 \func{bool}{DeletePage}{\param{int}{ page}}
 
 
 \func{bool}{DeletePage}{\param{int}{ page}}
 

-Deletes the specified page.
+Deletes the specified page, and the associated window.

 
 \membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist}
 
 
 \membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist}
 


@@ -146,13 +168,13 @@ Returns the number of pages in the notebook control.
 
 \membersection{wxNotebook::GetPageImage}\label{wxnotebookgetpageimage}
 
 
 \membersection{wxNotebook::GetPageImage}\label{wxnotebookgetpageimage}
 

-\constfunc{int}{GetPageImage}{\void}
+\constfunc{int}{GetPageImage}{\param{int }{nPage}}

 
 Returns the image index for the given page.
 
 \membersection{wxNotebook::GetPageText}\label{wxnotebookgetpagetext}
 
 
 Returns the image index for the given page.
 
 \membersection{wxNotebook::GetPageText}\label{wxnotebookgetpagetext}
 

-\constfunc{wxString}{GetPageText}{\void}
+\constfunc{wxString}{GetPageText}{\param{int }{nPage}}

 
 Returns the string for the given page.
 
 
 Returns the string for the given page.
 


@@ -166,7 +188,13 @@ Returns the number of rows in the notebook control.
 
 \constfunc{int}{GetSelection}{\void}
 
 
 \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}
 
 
 \membersection{wxNotebook::InsertPage}\label{wxnotebookinsertpage}
 


@@ -211,15 +239,23 @@ An event handler function, called when the page selection is changed.
 
 \helpref{wxNotebookEvent}{wxnotebookevent}
 
 
 \helpref{wxNotebookEvent}{wxnotebookevent}
 

+\membersection{wxNotebook::RemovePage}\label{wxnotebookremovepage}
+
+\func{bool}{RemovePage}{\param{int}{ page}}
+
+Deletes the specified page, without deleting the associated window.
+

 \membersection{wxNotebook::SetImageList}\label{wxnotebooksetimagelist}
 
 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
 
 \membersection{wxNotebook::SetImageList}\label{wxnotebooksetimagelist}
 
 \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}
 
 
 \wxheading{See also}
 

-\helpref{wxImageList}{wximagelist}
+\helpref{wxImageList}{wximagelist},
+\helpref{AssignImageList}{wxnotebookassignimagelist}

 
 \membersection{wxNotebook::SetPadding}\label{wxnotebooksetpadding}
 
 
 \membersection{wxNotebook::SetPadding}\label{wxnotebooksetpadding}