docs/doxygen/overviews/bookctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        bookctrl.h
   3 // Purpose:     topic overview
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /*!
  10
  11  @page overview_bookctrl wxBookCtrl overview
  12
  13  Classes: wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook
  14
  15
  16  @section overview_bookctrl_intro Introduction
  17
  18  A book control is a convenient way of displaying multiple pages of information,
  19  displayed one page at a time. wxWidgets has five variants of this control:
  20
  21   @li wxNotebook: uses a row of tabs
  22   @li wxListbook: controlled by a wxListCtrl
  23   @li wxChoicebook: controlled by a wxChoice
  24   @li wxTreebook: controlled by a wxTreeCtrl
  25   @li wxToolbook: controlled by a wxToolBar
  26
  27  See @ref page_utils_samples_notebook for an example of wxBookCtrl usage.
  28
  29
  30  @section overview_bookctrl_bestbookctrl Best book
  31
  32  wxBookCtrl is mapped to the class best suited for a given platform.
  33  Currently it provides wxChoicebook for smartphones equipped with
  34  WinCE, and wxNotebook for all other platforms. The mapping consists of:
  35
  36  @beginTable
  37  @row2col{wxBookCtrl, wxChoicebook or wxNotebook}
  38  @row2col{wxBookCtrlEvent, wxChoicebookEvent or wxNotebookEvent}
  39  @row2col{wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED,
  40           wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED}
  41  @row2col{wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING,
  42           wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING}
  43  @row2col{EVT_BOOKCTRL_PAGE_CHANGED(id\, fn),
  44           EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or EVT_NOTEBOOK_PAGE_CHANGED(id, fn)}
  45  @row2col{EVT_BOOKCTRL_PAGE_CHANGING(id\, fn),
  46           EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or EVT_NOTEBOOK_PAGE_CHANGING(id, fn)}
  47  @endTable
  48
  49  For orientation of the book controller, use following flags in style:
  50
  51  @li @b wxBK_TOP: controller above pages
  52  @li @b wxBK_BOTTOM: controller below pages
  53  @li @b wxBK_LEFT: controller on the left
  54  @li @b wxBK_RIGHT: controller on the right
  55  @li @b wxBK_DEFAULT: native controller placement
  56
  57 */
  58