Removed wxImageList overview, and other @ref fixes.

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

diff --git a/docs/doxygen/overviews/bookctrl.h b/docs/doxygen/overviews/bookctrl.h
index e64942a27851f0d2b6d5ed403f6417b09c0a7c37..51fd2c9b04f69a8251df84c71baef46a0f559d92 100644 (file)
--- a/docs/doxygen/overviews/bookctrl.h
+++ b/docs/doxygen/overviews/bookctrl.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

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


@@ -8,166 +8,57 @@
 
 /*!
 
 
 /*!
 

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

 
 

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

 
 

+ @li @ref overview_bookctrl_intro
+ @li @ref overview_bookctrl_bestbookctrl

 
 

- @section wxbookctrlintro 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:
-
-
-  #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
-
-
- See @ref samplenotebook_overview for an example of wxBookCtrl usage.
-
- @section wxbestbookctrl 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:
-
-
-
-
-
-
-
- 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)
+ <hr>

 
 
 
 

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

 
 

- EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or EVT_NOTEBOOK_PAGE_CHANGING(id, fn)
+  @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

 
 

+ See @ref page_utils_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{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

 
  For orientation of the book controller, use following flags in style:
 
 
  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

 
 

-
-
-
-
-
- @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
-
- */
-
+*/