docs/doxygen/overviews/bookctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        bookctrl.h
   3 // Purpose:     topic overview
   4 // Author:      wxWidgets team
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8 /**
   9
  10 @page overview_bookctrl wxBookCtrl Overview
  11
  12 @tableofcontents
  13
  14 A book control is a convenient way of displaying multiple pages of information,
  15 displayed one page at a time. wxWidgets has five variants of this control:
  16
  17 @li wxChoicebook: controlled by a wxChoice
  18 @li wxListbook: controlled by a wxListCtrl
  19 @li wxNotebook: uses a row of tabs
  20 @li wxSimplebook: doesn't allow the user to change the page at all.
  21 @li wxTreebook: controlled by a wxTreeCtrl
  22 @li wxToolbook: controlled by a wxToolBar
  23
  24 See the @ref page_samples_notebook for an example of wxBookCtrl usage.
  25
  26 Notice that wxSimplebook is special in that it only allows the program to
  27 change the selection, thus it's usually used in slightly different
  28 circumstances than the other variants.
  29
  30 @see @ref group_class_bookctrl
  31
  32
  33
  34 @section overview_bookctrl_bestbookctrl Best Book
  35
  36 ::wxBookCtrl is mapped to the class best suited for a given platform. Currently
  37 it provides wxChoicebook for smartphones equipped with WinCE, and wxNotebook
  38 for all other platforms. The mapping consists of:
  39
  40 @beginTable
  41 @row2col{ ::wxBookCtrl, wxChoicebook or wxNotebook }
  42 @row2col{ @c wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED,
  43           @c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or
  44           @c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED }
  45 @row2col{ @c wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING,
  46           @c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or
  47           @c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING }
  48 @row2col{ @c EVT_BOOKCTRL_PAGE_CHANGED(id\, fn),
  49           @c EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or
  50           @c EVT_NOTEBOOK_PAGE_CHANGED(id, fn) }
  51 @row2col{ @c EVT_BOOKCTRL_PAGE_CHANGING(id\, fn),
  52           @c EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or
  53           @c EVT_NOTEBOOK_PAGE_CHANGING(id, fn) }
  54 @endTable
  55
  56 For orientation of the book controller, use following flags in style:
  57
  58 @li @b wxBK_TOP: controller above pages
  59 @li @b wxBK_BOTTOM: controller below pages
  60 @li @b wxBK_LEFT: controller on the left
  61 @li @b wxBK_RIGHT: controller on the right
  62 @li @b wxBK_DEFAULT: native controller placement
  63
  64 */
  65