wxBookCtrl overview.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31927 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/choicebk.tex b/docs/latex/wx/choicebk.tex
index 3a86aa08b5d25c2364abec1b796a271db0a8ba15..ceefa44c5ba104f6df3c369f7b9467457b84c948 100644 (file)
--- a/docs/latex/wx/choicebk.tex
+++ b/docs/latex/wx/choicebk.tex
@@ -48,5 +48,5 @@ it is top).}
 
 \wxheading{See also}
 
-\helpref{wxNotebook}{wxnotebook}, \helpref{notebook sample}{samplenotebook}
+\helpref{wxBookCtrl}{wxbookctrloverview}, \helpref{wxNotebook}{wxnotebook}, \helpref{notebook sample}{samplenotebook}
 

diff --git a/docs/latex/wx/listbook.tex b/docs/latex/wx/listbook.tex
index be233a2ccfbab393978402347bf098bb226a459a..ff3fea234b61d2fdee38bfddcb7c2ebdc6550967 100644 (file)
--- a/docs/latex/wx/listbook.tex
+++ b/docs/latex/wx/listbook.tex
@@ -48,5 +48,5 @@ it is top).}
 
 \wxheading{See also}
 
-\helpref{wxNotebook}{wxnotebook}, \helpref{notebook sample}{samplenotebook}
+\helpref{wxBookCtrl}{wxbookctrloverview}, \helpref{wxNotebook}{wxnotebook}, \helpref{notebook sample}{samplenotebook}
 

diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex
index 114492e8d7400ce6010cc3f9082aedf442cf77fb..37e9040d98d6f3f759b508e32ff7f3917a925520 100644 (file)
--- a/docs/latex/wx/notebook.tex
+++ b/docs/latex/wx/notebook.tex
@@ -74,11 +74,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}

diff --git a/docs/latex/wx/tbook.tex b/docs/latex/wx/tbook.tex
new file mode 100644 (file)
index 0000000..457e9ae
--- /dev/null
+++ b/docs/latex/wx/tbook.tex
@@ -0,0 +1,52 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        tbook.tex
+%% Purpose:     wxBookCtrl overview
+%% Author:      Wlodzimierz ABX Skiba
+%% Modified by:
+%% Created:     11/18/2004
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\section{wxBookCtrl overview}\label{wxbookctrloverview}
+
+Classes: \helpref{wxNotebook}{wxnotebook}, \helpref{wxListbook}{wxlistbook}, \helpref{wxChoicebook}{wxchoicebook}
+
+\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:
+
+\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}
+\end{itemize}
+
+\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:
+
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{wxBookCtrl}{wxChoicebook or wxNotebook}
+\twocolitem{wxBookCtrlEvent}{wxChoicebookEvent or wxNotebookEvent}
+\twocolitem{wxEVT\_COMMAND\_BOOKCTRL\_PAGE\_CHANGED}{wxEVT\_COMMAND\_CHOICEBOOK\_PAGE\_CHANGED or wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED}
+\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

diff --git a/docs/latex/wx/topics.tex b/docs/latex/wx/topics.tex
index 7afc04f040806f54b88ce142cb2da9d5a38331fc..7cb08c38ed06adb03053d6bc29ac258bff18496e 100644 (file)
--- a/docs/latex/wx/topics.tex
+++ b/docs/latex/wx/topics.tex
@@ -43,6 +43,7 @@ This chapter contains a selection of topic overviews.
 \input ttreectl.tex
 \input tlistctl.tex
 \input timaglst.tex
+\input tbook.tex
 \input tcommdlg.tex
 \input tdocview.tex
 % Deprecated

diff --git a/docs/latex/wx/tsamples.tex b/docs/latex/wx/tsamples.tex
index d20037ea77d6a8649fda1e6ea0c51b015a11b4e1..72573da3d7583c76dff7d70f68ced62cafe006b3 100644 (file)
--- a/docs/latex/wx/tsamples.tex
+++ b/docs/latex/wx/tsamples.tex
@@ -352,7 +352,7 @@ It replaces the old dynamic sample.
 
 \subsection{Notebook sample}\label{samplenotebook}
 
-This samples shows family of controls which derive from wxBookCtrlBase base class.
+This samples shows \helpref{wxBookCtrl}{wxbookctrloverview} family of controls.
 Although initially it was written to demonstrate \helpref{wxNotebook}{wxnotebook}
 only, it can now be also used to see \helpref{wxListbook}{wxlistbook} and
 \helpref{wxChoicebook}{wxchoicebook} in action. Test each of the controls, their