fixed typo in GetNextItem example (bug 1333797)

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

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% 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 displaying multiple pages of information,
displayed one page at a time. wxWidgets has three variants of this control:

\begin{itemize}\itemsep=0pt
\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}
\end{itemize}

\subsection{Best book}\label{wxbestbookctrl}

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
\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 {\tt samples/widgets} for an example of wxBookCtrl usage.