docs/latex/wx/tbook.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        tbook.tex
   3 %% Purpose:     wxBookCtrl overview
   4 %% Author:      Wlodzimierz ABX Skiba
   5 %% Modified by:
   6 %% Created:     11/18/2004
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) wxWidgets team
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{wxBookCtrl overview}\label{wxbookctrloverview}
  13
  14 Classes: \helpref{wxNotebook}{wxnotebook}, \helpref{wxListbook}{wxlistbook}, \helpref{wxChoicebook}{wxchoicebook}
  15
  16 \subsection{Introduction}\label{wxbookctrlintro}
  17
  18 A book control is a convenient way of application control and presentation of information
  19 in the same window, without having to display it all at the same time. Such control defines
  20 multiple pages controlled by driver control. wxWidgets has three variants of this control
  21 differentiated by their pilot-like subcontrol:
  22
  23 \begin{itemize}\itemsep=0pt
  24 \item \helpref{wxNotebook}{wxnotebook} usually with native tab control
  25 \item \helpref{wxListbook}{wxlistbook} controlled by \helpref{wxListCtrl}{wxlistctrl}
  26 \item \helpref{wxChoicebook}{wxchoicebook} controlled by \helpref{wxChoice}{wxchoice}
  27 \end{itemize}
  28
  29 \subsection{Best book}\label{wxbestbookctrl}
  30
  31 Just like \helpref{wxConfigBase}{wxconfigbase} class represents most native type of configuration
  32 storage, also book controls are special wrapper called wxBookCtrl which is mapped to the
  33 class best suited for given platform. Currently it serves \helpref{wxChoicebook}{wxchoicebook}
  34 for smartphones equipped with WinCE and \helpref{wxNotebook}{wxnotebook} for all other platforms.
  35 Mapping consists in:
  36
  37 \twocolwidtha{5cm}
  38 \begin{twocollist}\itemsep=0pt
  39 \twocolitem{wxBookCtrl}{wxChoicebook or wxNotebook}
  40 \twocolitem{wxBookCtrlEvent}{wxChoicebookEvent or wxNotebookEvent}
  41 \twocolitem{wxEVT\_COMMAND\_BOOKCTRL\_PAGE\_CHANGED}{wxEVT\_COMMAND\_CHOICEBOOK\_PAGE\_CHANGED or wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED}
  42 \twocolitem{wxEVT\_COMMAND\_BOOKCTRL\_PAGE\_CHANGING}{wxEVT\_COMMAND\_CHOICEBOOK\_PAGE\_CHANGING or wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING}
  43 \twocolitem{EVT\_BOOKCTRL\_PAGE\_CHANGED(id, fn)}{EVT\_CHOICEBOOK\_PAGE\_CHANGED(id, fn) or EVT\_NOTEBOOK\_PAGE\_CHANGED(id, fn)}
  44 \twocolitem{EVT\_BOOKCTRL\_PAGE\_CHANGING(id, fn)}{EVT\_CHOICEBOOK\_PAGE\_CHANGING(id, fn) or EVT\_NOTEBOOK\_PAGE\_CHANGING(id, fn)}
  45 \twocolitem{\windowstyle{wxBC\_TOP}}{\windowstyle{wxCHB\_TOP} or \windowstyle{wxNB\_TOP}}
  46 \twocolitem{\windowstyle{wxBC\_BOTTOM}}{\windowstyle{wxCHB\_BOTTOM} or \windowstyle{wxNB\_BOTTOM}}
  47 \twocolitem{\windowstyle{wxBC\_LEFT}}{\windowstyle{wxCHB\_LEFT} or \windowstyle{wxNB\_LEFT}}
  48 \twocolitem{\windowstyle{wxBC\_RIGHT}}{\windowstyle{wxCHB\_RIGHT} or \windowstyle{wxNB\_RIGHT}}
  49 \twocolitem{\windowstyle{wxBC\_DEFAULT}}{\windowstyle{wxCHB\_DEFAULT} or \windowstyle{wxNB\_DEFAULT}}
  50 \end{twocollist}
  51
  52 See Widgets sample for the presentation of wxBookCtrl usage.