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