docs/doxygen/overviews/bookctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        bookctrl
   3 // Purpose:     topic overview
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /*!
  10
  11  @page bookctrl_overview wxBookCtrl overview
  12
  13  Classes: #wxNotebook, #wxListbook, #wxChoicebook,
  14  #wxTreebook, #wxToolbook
  15  #Introduction
  16  @ref bestbookctrl_overview
  17
  18
  19  @section wxbookctrlintro Introduction
  20
  21  A book control is a convenient way of displaying multiple pages of information,
  22  displayed one page at a time. wxWidgets has five variants of this control:
  23
  24
  25   #wxNotebook: uses a row of tabs
  26   #wxListbook: controlled by a #wxListCtrl
  27   #wxChoicebook: controlled by a #wxChoice
  28   #wxTreebook: controlled by a #wxTreeCtrl
  29   #wxToolbook: controlled by a #wxToolBar
  30
  31
  32  See @ref samplenotebook_overview for an example of wxBookCtrl usage.
  33
  34  @section wxbestbookctrl Best book
  35
  36  wxBookCtrl is mapped to the class best suited for a given platform.
  37  Currently it provides #wxChoicebook for smartphones equipped with
  38  WinCE, and #wxNotebook for all other platforms. The mapping consists of:
  39
  40
  41
  42
  43
  44
  45
  46  wxBookCtrl
  47
  48
  49
  50
  51  wxChoicebook or wxNotebook
  52
  53
  54
  55
  56
  57  wxBookCtrlEvent
  58
  59
  60
  61
  62  wxChoicebookEvent or wxNotebookEvent
  63
  64
  65
  66
  67
  68  wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED
  69
  70
  71
  72
  73  wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
  74
  75
  76
  77
  78
  79  wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING
  80
  81
  82
  83
  84  wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
  85
  86
  87
  88
  89
  90  EVT_BOOKCTRL_PAGE_CHANGED(id, fn)
  91
  92
  93
  94
  95  EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or EVT_NOTEBOOK_PAGE_CHANGED(id, fn)
  96
  97
  98
  99
 100
 101  EVT_BOOKCTRL_PAGE_CHANGING(id, fn)
 102
 103
 104
 105
 106  EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or EVT_NOTEBOOK_PAGE_CHANGING(id, fn)
 107
 108
 109
 110
 111
 112  For orientation of the book controller, use following flags in style:
 113
 114
 115
 116
 117
 118
 119
 120  @b wxBK_TOP
 121
 122
 123
 124
 125  controller above pages
 126
 127
 128
 129
 130
 131  @b wxBK_BOTTOM
 132
 133
 134
 135
 136  controller below pages
 137
 138
 139
 140
 141
 142  @b wxBK_LEFT
 143
 144
 145
 146
 147  controller on the left
 148
 149
 150
 151
 152
 153  @b wxBK_RIGHT
 154
 155
 156
 157
 158  controller on the right
 159
 160
 161
 162
 163
 164  @b wxBK_DEFAULT
 165
 166
 167
 168
 169  native controller placement
 170
 171  */
 172
 173