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