]>
Commit | Line | Data |
---|---|---|
15b6757b | 1 | ///////////////////////////////////////////////////////////////////////////// |
59c0db6a | 2 | // Name: bookctrl.h |
15b6757b FM |
3 | // Purpose: topic overview |
4 | // Author: wxWidgets team | |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | /*! | |
36c9828f | 10 | |
59c0db6a | 11 | @page overview_bookctrl wxBookCtrl overview |
36c9828f | 12 | |
98ba1eee | 13 | Classes: wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook |
36c9828f | 14 | |
30738aae FM |
15 | @li @ref overview_bookctrl_intro |
16 | @li @ref overview_bookctrl_bestbookctrl | |
17 | ||
18 | ||
19 | <hr> | |
20 | ||
36c9828f | 21 | |
59c0db6a | 22 | @section overview_bookctrl_intro Introduction |
36c9828f | 23 | |
15b6757b FM |
24 | A book control is a convenient way of displaying multiple pages of information, |
25 | displayed one page at a time. wxWidgets has five variants of this control: | |
36c9828f | 26 | |
59c0db6a | 27 | @li wxNotebook: uses a row of tabs |
98ba1eee FM |
28 | @li wxListbook: controlled by a wxListCtrl |
29 | @li wxChoicebook: controlled by a wxChoice | |
30 | @li wxTreebook: controlled by a wxTreeCtrl | |
31 | @li wxToolbook: controlled by a wxToolBar | |
36c9828f | 32 | |
98ba1eee | 33 | See @ref page_utils_samples_notebook for an example of wxBookCtrl usage. |
36c9828f | 34 | |
59c0db6a FM |
35 | |
36 | @section overview_bookctrl_bestbookctrl Best book | |
36c9828f | 37 | |
15b6757b | 38 | wxBookCtrl is mapped to the class best suited for a given platform. |
98ba1eee FM |
39 | Currently it provides wxChoicebook for smartphones equipped with |
40 | WinCE, and wxNotebook for all other platforms. The mapping consists of: | |
36c9828f | 41 | |
59c0db6a FM |
42 | @beginTable |
43 | @row2col{wxBookCtrl, wxChoicebook or wxNotebook} | |
44 | @row2col{wxBookCtrlEvent, wxChoicebookEvent or wxNotebookEvent} | |
45 | @row2col{wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED, | |
46 | wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED} | |
47 | @row2col{wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING, | |
48 | wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING} | |
49 | @row2col{EVT_BOOKCTRL_PAGE_CHANGED(id\, fn), | |
50 | EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or EVT_NOTEBOOK_PAGE_CHANGED(id, fn)} | |
51 | @row2col{EVT_BOOKCTRL_PAGE_CHANGING(id\, fn), | |
52 | EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or EVT_NOTEBOOK_PAGE_CHANGING(id, fn)} | |
53 | @endTable | |
36c9828f | 54 | |
15b6757b | 55 | For orientation of the book controller, use following flags in style: |
36c9828f | 56 | |
59c0db6a FM |
57 | @li @b wxBK_TOP: controller above pages |
58 | @li @b wxBK_BOTTOM: controller below pages | |
59 | @li @b wxBK_LEFT: controller on the left | |
60 | @li @b wxBK_RIGHT: controller on the right | |
61 | @li @b wxBK_DEFAULT: native controller placement | |
36c9828f | 62 | |
59c0db6a | 63 | */ |
36c9828f | 64 |