]>
Commit | Line | Data |
---|---|---|
15b6757b | 1 | ///////////////////////////////////////////////////////////////////////////// |
59c0db6a | 2 | // Name: bookctrl.h |
15b6757b FM |
3 | // Purpose: topic overview |
4 | // Author: wxWidgets team | |
526954c5 | 5 | // Licence: wxWindows licence |
15b6757b FM |
6 | ///////////////////////////////////////////////////////////////////////////// |
7 | ||
880efa2a | 8 | /** |
36c9828f | 9 | |
880efa2a | 10 | @page overview_bookctrl wxBookCtrl Overview |
36c9828f | 11 | |
e7054054 | 12 | @tableofcontents |
36c9828f | 13 | |
880efa2a BP |
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: | |
36c9828f | 16 | |
880efa2a BP |
17 | @li wxChoicebook: controlled by a wxChoice |
18 | @li wxListbook: controlled by a wxListCtrl | |
19 | @li wxNotebook: uses a row of tabs | |
cc699de8 | 20 | @li wxSimplebook: doesn't allow the user to change the page at all. |
880efa2a BP |
21 | @li wxTreebook: controlled by a wxTreeCtrl |
22 | @li wxToolbook: controlled by a wxToolBar | |
59c0db6a | 23 | |
dc28cdf8 | 24 | See the @ref page_samples_notebook for an example of wxBookCtrl usage. |
36c9828f | 25 | |
cc699de8 VZ |
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. | |
36c9828f | 29 | |
e7054054 BP |
30 | @see @ref group_class_bookctrl |
31 | ||
32 | ||
33 | ||
880efa2a | 34 | @section overview_bookctrl_bestbookctrl Best Book |
36c9828f | 35 | |
d8231db2 | 36 | ::wxBookCtrl is mapped to the class best suited for a given platform. Currently |
880efa2a BP |
37 | it provides wxChoicebook for smartphones equipped with WinCE, and wxNotebook |
38 | for all other platforms. The mapping consists of: | |
36c9828f | 39 | |
880efa2a | 40 | @beginTable |
d8231db2 FM |
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) } | |
880efa2a BP |
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 | |
36c9828f | 63 | |
59c0db6a | 64 | */ |
36c9828f | 65 |