escape more underscores (we need a pre-commit check for those...)

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

diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex
index 114492e8d7400ce6010cc3f9082aedf442cf77fb..038be5568b608c6385de1a27667ca77bc05cafb1 100644 (file)
--- a/docs/latex/wx/notebook.tex
+++ b/docs/latex/wx/notebook.tex
@@ -23,13 +23,14 @@ managed by wxNotebook.
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
-
+\twocolitem{\windowstyle{wxNB\_TOP}}{Place tabs on the top side.}
 \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.}
 \twocolitem{\windowstyle{wxNB\_FIXEDWIDTH}}{(Windows only) All tabs will have same width.}
 \twocolitem{\windowstyle{wxNB\_MULTILINE}}{(Windows only) There can be several rows of tabs.}
 \twocolitem{\windowstyle{wxNB\_NOPAGETHEME}}{(Windows only) Display a solid colour on notebook pages, and not a gradient, which can reduce performance.}
+\twocolitem{\windowstyle{wxNB\_FLAT}}{(Windows CE only) Show tabs in a flat style.}
 
 \end{twocollist}
 
@@ -45,7 +46,7 @@ See also \helpref{window styles overview}{windowstyles}.
 On Windows XP, the default theme paints a gradient on the notebook's pages.
 If you wish to suppress this theme, for aesthetic or performance reasons,
 there are three ways of doing it. You can use wxNB\_NOPAGETHEME to disable
-themed drawing for a particular notebook, you can call {\tt wxSystemOptions::SetOption} 
+themed drawing for a particular notebook, you can call {\tt wxSystemOptions::SetOption}
 to disable it for the whole application, or you can disable it for individual
 pages by using {\tt SetBackgroundColour}.
 
@@ -74,11 +75,10 @@ and the above code will therefore work on all platforms.
 
 \wxheading{See also}
 
-\helpref{wxNotebookEvent}{wxnotebookevent}, \helpref{wxImageList}{wximagelist},\rtfsp
+\helpref{wxBookCtrl}{wxbookctrloverview}, \helpref{wxNotebookEvent}{wxnotebookevent}, \helpref{wxImageList}{wximagelist}, \helpref{notebook sample}{samplenotebook}\rtfsp
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-
 \membersection{wxNotebook::wxNotebook}\label{wxnotebookctor}
 
 \func{}{wxNotebook}{\void}
@@ -199,7 +199,7 @@ The call to this function generates the page changing events.
 
 \constfunc{wxWindow *}{GetCurrentPage}{\void}
 
-Returns the currently selected notebook age or \texttt{NULL}.
+Returns the currently selected notebook page or \NULL.
 
 
 \membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist}
@@ -273,11 +273,9 @@ to {\tt SetBackgroundColour}. Otherwise, an uninitialised colour will be returne
 \func{int}{HitTest}{\param{const wxPoint\&}{ pt}, \param{long}{ *flags = {\tt NULL}}}
 
 Returns the index of the tab at the specified position or {\tt wxNOT\_FOUND}
-if none. If {\it flags} parameter is non {\tt NULL}, the position of the point
+if none. If {\it flags} parameter is non-{\tt NULL}, the position of the point
 inside the tab is returned as well.
 
-{\bf NB: } This method is currently only implemented under wxMSW and wxUniv.
-
 \wxheading{Parameters}
 
 \docparam{pt}{Specifies the point for the hit test.}
@@ -285,10 +283,11 @@ inside the tab is returned as well.
 \docparam{flags}{Return value for detailed information. One of the following values:
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf wxNB\_HITTEST\_NOWHERE}}{There was no tab under this point.}
-\twocolitem{{\bf wxNB\_HITTEST\_ONICON}}{The point was over an icon (currently wxMSW only).}
-\twocolitem{{\bf wxNB\_HITTEST\_ONLABEL}}{The point was over a label (currently wxMSW only).}
-\twocolitem{{\bf wxNB\_HITTEST\_ONITEM}}{The point was over an item, but not on the label or icon.}
+\twocolitem{{\bf wxBK\_HITTEST\_NOWHERE}}{There was no tab under this point.}
+\twocolitem{{\bf wxBK\_HITTEST\_ONICON}}{The point was over an icon (currently wxMSW only).}
+\twocolitem{{\bf wxBK\_HITTEST\_ONLABEL}}{The point was over a label (currently wxMSW only).}
+\twocolitem{{\bf wxBK\_HITTEST\_ONITEM}}{The point was over an item, but not on the label or icon.}
+\twocolitem{{\bf wxBK\_HITTEST\_ONPAGE}}{The point was over a currently selected page, not over any tab. Note that this flag is present only if {\tt wxNOT\_FOUND} is returned.}
 \end{twocollist}
 }
 
@@ -405,8 +404,21 @@ Sets the selection for the given page, returning the previous selection.
 
 The call to this function generates the page changing events.
 
+This function is deprecated and should not be used in new code. Please use the
+\helpref{ChangeSelection}{wxnotebookchangeselection} function instead.
+
 \wxheading{See also}
 
 \helpref{wxNotebook::GetSelection}{wxnotebookgetselection}
 
 
+
+\membersection{wxNotebook::ChangeSelection}\label{wxnotebookchangeselection}
+
+\func{int}{ChangeSelection}{\param{size\_t}{ page}}
+
+Changes the selection for the given page, returning the previous selection.
+
+The call to this function \emph{does not} generate the page changing events.
+This is the only difference with \helpref{SetSelection}{wxnotebooksetselection}.
+See \helpref{this topic}{progevent} for more info.