X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/30738aae14dfbce0c492d8696c861947228028c2..7447d53c35249d42128d6243c90998f03882859a:/docs/doxygen/overviews/bookctrl.h
diff --git a/docs/doxygen/overviews/bookctrl.h b/docs/doxygen/overviews/bookctrl.h
index 51fd2c9b04..f71f172757 100644
--- a/docs/doxygen/overviews/bookctrl.h
+++ b/docs/doxygen/overviews/bookctrl.h
@@ -3,62 +3,73 @@
// Purpose: topic overview
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-/*!
+/**
- @page overview_bookctrl wxBookCtrl overview
+@page overview_bookctrl wxBookCtrl Overview
- Classes: wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook
+Classes:
- @li @ref overview_bookctrl_intro
- @li @ref overview_bookctrl_bestbookctrl
+@li wxChoicebook
+@li wxListbook
+@li wxNotebook
+@li wxTreebook
+@li wxToolbook
+Sections:
-
+@li @ref overview_bookctrl_intro
+@li @ref overview_bookctrl_bestbookctrl
- @section overview_bookctrl_intro Introduction
+
- 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 wxNotebook: uses a row of tabs
- @li wxListbook: controlled by a wxListCtrl
- @li wxChoicebook: controlled by a wxChoice
- @li wxTreebook: controlled by a wxTreeCtrl
- @li wxToolbook: controlled by a wxToolBar
+@section overview_bookctrl_intro Introduction
- See @ref page_utils_samples_notebook for an example of wxBookCtrl usage.
+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 wxTreebook: controlled by a wxTreeCtrl
+@li wxToolbook: controlled by a wxToolBar
- @section overview_bookctrl_bestbookctrl Best book
+See the @ref page_samples_notebook for an example of wxBookCtrl usage.
- 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{wxBookCtrlEvent, wxChoicebookEvent or wxNotebookEvent}
- @row2col{wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED,
- wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED}
- @row2col{wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING,
- wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING}
- @row2col{EVT_BOOKCTRL_PAGE_CHANGED(id\, fn),
- EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or EVT_NOTEBOOK_PAGE_CHANGED(id, fn)}
- @row2col{EVT_BOOKCTRL_PAGE_CHANGING(id\, fn),
- EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or EVT_NOTEBOOK_PAGE_CHANGING(id, fn)}
- @endTable
+@section overview_bookctrl_bestbookctrl Best Book
- For orientation of the book controller, use following flags in style:
+::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:
- @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
+@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
*/