Update docs to mention wxRefCounter class

[wxWidgets.git] / docs / doxygen / overviews / bookctrl.h

diff --git a/docs/doxygen/overviews/bookctrl.h b/docs/doxygen/overviews/bookctrl.h
index e64942a27851f0d2b6d5ed403f6417b09c0a7c37..dbb2b6820a539bc451eac295c9f848b9f3a5940e 100644 (file)
--- a/docs/doxygen/overviews/bookctrl.h
+++ b/docs/doxygen/overviews/bookctrl.h
@@ -1,173 +1,75 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        bookctrl
+// Name:        bookctrl.h

 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-/*!
+/**

 
 

- @page bookctrl_overview wxBookCtrl overview
+@page overview_bookctrl wxBookCtrl Overview

 
 

- Classes: #wxNotebook, #wxListbook, #wxChoicebook,
- #wxTreebook, #wxToolbook
- #Introduction
- @ref bestbookctrl_overview
+Classes:

 
 

+@li wxChoicebook
+@li wxListbook
+@li wxNotebook
+@li wxTreebook
+@li wxToolbook

 
 

- @section wxbookctrlintro Introduction
+Sections:

 
 

- 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 @ref overview_bookctrl_intro
+@li @ref overview_bookctrl_bestbookctrl

 
 
 
 

-  #wxNotebook: uses a row of tabs
-  #wxListbook: controlled by a #wxListCtrl
-  #wxChoicebook: controlled by a #wxChoice
-  #wxTreebook: controlled by a #wxTreeCtrl
-  #wxToolbook: controlled by a #wxToolBar
+<hr>

 
 
 
 

- See @ref samplenotebook_overview for an example of wxBookCtrl usage.
+@section overview_bookctrl_intro Introduction

 
 

- @section wxbestbookctrl Best book
+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:

 
 

- 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 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

 
 

+See the @ref page_samples_notebook for an example of wxBookCtrl usage.

 
 
 
 

+@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:

 
 

- wxBookCtrl
-
-
-
-
- wxChoicebook or wxNotebook
-
-
-
-
-
- wxBookCtrlEvent
-
-
-
-
- wxChoicebookEvent or wxNotebookEvent
-
-
-
-
-
- wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED
-
-
-
-
- wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
-
-
-
-
-
- wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING
-
-
-
-
- wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
-
-
-
-
-
- EVT_BOOKCTRL_PAGE_CHANGED(id, fn)
-
-
-
-
- EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or EVT_NOTEBOOK_PAGE_CHANGED(id, fn)
-
-
-
-
-
- EVT_BOOKCTRL_PAGE_CHANGING(id, fn)
-
-
-
-
- EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or EVT_NOTEBOOK_PAGE_CHANGING(id, fn)
-
-
-
-
-
- For orientation of the book controller, use following flags in style:
-
-
-
-
-
-
-
- @b wxBK_TOP
-
-
-
-
- controller above pages
-
-
-
-
-
- @b wxBK_BOTTOM
-
-
-
-
- controller below pages
-
-
-
-
-
- @b wxBK_LEFT
-
-
-
-
- controller on the left
-
-
-
-
-
- @b wxBK_RIGHT
-
-
-
-
- controller on the right
-
-
-
-
-
- @b wxBK_DEFAULT
-
-
-
-
- native controller placement
-
- */
+@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

 
 

+*/