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