add docs for the #define of wxBookCtrl

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56271 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-13 11:03:01 +00:00
parent 1b895132c9
commit d8231db24d
2 changed files with 21 additions and 15 deletions

View File

@@ -43,25 +43,24 @@ See the @ref page_samples_notebook for an example of wxBookCtrl usage.
@section overview_bookctrl_bestbookctrl Best Book @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 it provides wxChoicebook for smartphones equipped with WinCE, and wxNotebook
for all other platforms. The mapping consists of: for all other platforms. The mapping consists of:
@beginTable @beginTable
@row2col{ wxBookCtrl, wxChoicebook or wxNotebook } @row2col{ ::wxBookCtrl, wxChoicebook or wxNotebook }
@row2col{ wxBookCtrlEvent, wxChoicebookEvent or wxNotebookEvent } @row2col{ @c wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED,
@row2col{ wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED, @c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or
wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or @c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED }
wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED } @row2col{ @c wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING,
@row2col{ wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING, @c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or
wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or @c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING }
wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING } @row2col{ @c EVT_BOOKCTRL_PAGE_CHANGED(id\, fn),
@row2col{ EVT_BOOKCTRL_PAGE_CHANGED(id\, fn), @c EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or
EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or @c EVT_NOTEBOOK_PAGE_CHANGED(id, fn) }
EVT_NOTEBOOK_PAGE_CHANGED(id, fn) } @row2col{ @c EVT_BOOKCTRL_PAGE_CHANGING(id\, fn),
@row2col{ EVT_BOOKCTRL_PAGE_CHANGING(id\, fn), @c EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or
EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or @c EVT_NOTEBOOK_PAGE_CHANGING(id, fn) }
EVT_NOTEBOOK_PAGE_CHANGING(id, fn) }
@endTable @endTable
For orientation of the book controller, use following flags in style: For orientation of the book controller, use following flags in style:

View File

@@ -336,6 +336,13 @@ public:
*/ */
}; };
/**
wxBookCtrl is defined to one of the 'real' book controls.
See @ref overview_bookctrl for more info.
*/
#define wxBookCtrl TheBestBookCtrlForTheCurrentPlatform
/** /**
@class wxBookCtrlEvent @class wxBookCtrlEvent