no changes, just come cleanup and more comments

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

diff --git a/docs/latex/wx/tbook.tex b/docs/latex/wx/tbook.tex
index 457e9ae49d460ab96790ca5ccae0e20f8c169a47..a3acd20b4de1f246b287919ecf01cc5241733b9b 100644 (file)
--- a/docs/latex/wx/tbook.tex
+++ b/docs/latex/wx/tbook.tex
@@ -11,28 +11,29 @@
 
 \section{wxBookCtrl overview}\label{wxbookctrloverview}
 
-Classes: \helpref{wxNotebook}{wxnotebook}, \helpref{wxListbook}{wxlistbook}, \helpref{wxChoicebook}{wxchoicebook}
+Classes: \helpref{wxNotebook}{wxnotebook}, \helpref{wxListbook}{wxlistbook}, \helpref{wxChoicebook}{wxchoicebook},
+\helpref{wxTreebook}{wxtreebook}, \helpref{wxToolbook}{wxtoolbook}
 
 \subsection{Introduction}\label{wxbookctrlintro}
 
-A book control is a convenient way of application control and presentation of information
-in the same window, without having to display it all at the same time. Such control defines
-multiple pages controlled by driver control. wxWidgets has three variants of this control
-differentiated by their pilot-like subcontrol:
+A book control is a convenient way of displaying multiple pages of information,
+displayed one page at a time. wxWidgets has five variants of this control:
 
 \begin{itemize}\itemsep=0pt
-\item \helpref{wxNotebook}{wxnotebook} usually with native tab control
-\item \helpref{wxListbook}{wxlistbook} controlled by \helpref{wxListCtrl}{wxlistctrl}
-\item \helpref{wxChoicebook}{wxchoicebook} controlled by \helpref{wxChoice}{wxchoice}
+\item \helpref{wxNotebook}{wxnotebook}: uses a row of tabs
+\item \helpref{wxListbook}{wxlistbook}: controlled by a \helpref{wxListCtrl}{wxlistctrl}
+\item \helpref{wxChoicebook}{wxchoicebook}: controlled by a \helpref{wxChoice}{wxchoice}
+\item \helpref{wxTreebook}{wxtreebook}: controlled by a \helpref{wxTreeCtrl}{wxtreectrl}
+\item \helpref{wxToolbook}{wxtoolbook}: controlled by a \helpref{wxToolBar}{wxtoolbar}
 \end{itemize}
 
+See \helpref{Notebook sample}{samplenotebook} for an example of wxBookCtrl usage.
+
 \subsection{Best book}\label{wxbestbookctrl}
 
-Just like \helpref{wxConfigBase}{wxconfigbase} class represents most native type of configuration
-storage, also book controls are special wrapper called wxBookCtrl which is mapped to the
-class best suited for given platform. Currently it serves \helpref{wxChoicebook}{wxchoicebook}
-for smartphones equipped with WinCE and \helpref{wxNotebook}{wxnotebook} for all other platforms.
-Mapping consists in:
+wxBookCtrl is mapped to the class best suited for a given platform.
+Currently it provides \helpref{wxChoicebook}{wxchoicebook} for smartphones equipped with
+WinCE, and \helpref{wxNotebook}{wxnotebook} for all other platforms. The mapping consists of:
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
@@ -42,11 +43,14 @@ Mapping consists in:
 \twocolitem{wxEVT\_COMMAND\_BOOKCTRL\_PAGE\_CHANGING}{wxEVT\_COMMAND\_CHOICEBOOK\_PAGE\_CHANGING or wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING}
 \twocolitem{EVT\_BOOKCTRL\_PAGE\_CHANGED(id, fn)}{EVT\_CHOICEBOOK\_PAGE\_CHANGED(id, fn) or EVT\_NOTEBOOK\_PAGE\_CHANGED(id, fn)}
 \twocolitem{EVT\_BOOKCTRL\_PAGE\_CHANGING(id, fn)}{EVT\_CHOICEBOOK\_PAGE\_CHANGING(id, fn) or EVT\_NOTEBOOK\_PAGE\_CHANGING(id, fn)}
-\twocolitem{\windowstyle{wxBC\_TOP}}{\windowstyle{wxCHB\_TOP} or \windowstyle{wxNB\_TOP}}
-\twocolitem{\windowstyle{wxBC\_BOTTOM}}{\windowstyle{wxCHB\_BOTTOM} or \windowstyle{wxNB\_BOTTOM}}
-\twocolitem{\windowstyle{wxBC\_LEFT}}{\windowstyle{wxCHB\_LEFT} or \windowstyle{wxNB\_LEFT}}
-\twocolitem{\windowstyle{wxBC\_RIGHT}}{\windowstyle{wxCHB\_RIGHT} or \windowstyle{wxNB\_RIGHT}}
-\twocolitem{\windowstyle{wxBC\_DEFAULT}}{\windowstyle{wxCHB\_DEFAULT} or \windowstyle{wxNB\_DEFAULT}}
 \end{twocollist}
 
-See Widgets sample for the presentation of wxBookCtrl usage.
\ No newline at end of file
+For orientation of the book controller, use following flags in style:
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxBK\_TOP}}{controller above pages}
+\twocolitem{\windowstyle{wxBK\_BOTTOM}}{controller below pages}
+\twocolitem{\windowstyle{wxBK\_LEFT}}{controller on the left}
+\twocolitem{\windowstyle{wxBK\_RIGHT}}{controller on the right}
+\twocolitem{\windowstyle{wxBK\_DEFAULT}}{native controller placement}
+\end{twocollist}