3f66f6a5b3
This keyword is not expanded by Git which means it's not replaced with the correct revision value in the releases made using git-based scripts and it's confusing to have lines with unexpanded "$Id$" in the released files. As expanding them with Git is not that simple (it could be done with git archive and export-subst attribute) and there are not many benefits in having them in the first place, just remove all these lines. If nothing else, this will make an eventual transition to Git simpler. Closes #14487. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
66 lines
2.3 KiB
C
66 lines
2.3 KiB
C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: bookctrl.h
|
|
// Purpose: topic overview
|
|
// Author: wxWidgets team
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
|
|
@page overview_bookctrl wxBookCtrl Overview
|
|
|
|
@tableofcontents
|
|
|
|
A book control is a convenient way of displaying multiple pages of information,
|
|
displayed one page at a time. wxWidgets has five variants of this control:
|
|
|
|
@li wxChoicebook: controlled by a wxChoice
|
|
@li wxListbook: controlled by a wxListCtrl
|
|
@li wxNotebook: uses a row of tabs
|
|
@li wxSimplebook: doesn't allow the user to change the page at all.
|
|
@li wxTreebook: controlled by a wxTreeCtrl
|
|
@li wxToolbook: controlled by a wxToolBar
|
|
|
|
See the @ref page_samples_notebook for an example of wxBookCtrl usage.
|
|
|
|
Notice that wxSimplebook is special in that it only allows the program to
|
|
change the selection, thus it's usually used in slightly different
|
|
circumstances than the other variants.
|
|
|
|
@see @ref group_class_bookctrl
|
|
|
|
|
|
|
|
@section overview_bookctrl_bestbookctrl Best Book
|
|
|
|
::wxBookCtrl is mapped to the class best suited for a given platform. Currently
|
|
it provides wxChoicebook for smartphones equipped with WinCE, and wxNotebook
|
|
for all other platforms. The mapping consists of:
|
|
|
|
@beginTable
|
|
@row2col{ ::wxBookCtrl, wxChoicebook or wxNotebook }
|
|
@row2col{ @c wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED,
|
|
@c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or
|
|
@c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED }
|
|
@row2col{ @c wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING,
|
|
@c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or
|
|
@c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING }
|
|
@row2col{ @c EVT_BOOKCTRL_PAGE_CHANGED(id\, fn),
|
|
@c EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or
|
|
@c EVT_NOTEBOOK_PAGE_CHANGED(id, fn) }
|
|
@row2col{ @c EVT_BOOKCTRL_PAGE_CHANGING(id\, fn),
|
|
@c EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or
|
|
@c EVT_NOTEBOOK_PAGE_CHANGING(id, fn) }
|
|
@endTable
|
|
|
|
For orientation of the book controller, use following flags in style:
|
|
|
|
@li @b wxBK_TOP: controller above pages
|
|
@li @b wxBK_BOTTOM: controller below pages
|
|
@li @b wxBK_LEFT: controller on the left
|
|
@li @b wxBK_RIGHT: controller on the right
|
|
@li @b wxBK_DEFAULT: native controller placement
|
|
|
|
*/
|
|
|