Documentation screenshot generator source code cleanup.

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

diff --git a/docs/doxygen/overviews/bookctrl.h b/docs/doxygen/overviews/bookctrl.h
index ff76a6759eef1ab3f692bf096d2ce90970f89aa5..9b4677e4ee509469ed2ae39762f46852280d52fb 100644 (file)
--- a/docs/doxygen/overviews/bookctrl.h
+++ b/docs/doxygen/overviews/bookctrl.h
@@ -3,7 +3,7 @@
 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -15,6 +15,7 @@ Classes:
 @li wxChoicebook
 @li wxListbook
 @li wxNotebook
+@li wxSimplebook
 @li wxTreebook
 @li wxToolbook
 
@@ -35,33 +36,36 @@ 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_utils_samples_notebook for an example of wxBookCtrl usage.
+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.
 
 @section overview_bookctrl_bestbookctrl Best Book
 
-wxBookCtrl is mapped to the class best suited for a given platform. Currently
+::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) }
+@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: