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

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

/*!

 @page bookctrl_overview wxBookCtrl overview

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


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


 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

 */
Commit	Line	Data
15b6757b FM	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: bookctrl
	3	// Purpose: topic overview
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/*!
36c9828f	10
15b6757b	11	@page bookctrl_overview wxBookCtrl overview
36c9828f	12
15b6757b FM	13	Classes: #wxNotebook, #wxListbook, #wxChoicebook,
	14	#wxTreebook, #wxToolbook
	15	#Introduction
	16	@ref bestbookctrl_overview
36c9828f FM	17
36c9828f FM	18
15b6757b	19	@section wxbookctrlintro Introduction
36c9828f	20
15b6757b FM	21	A book control is a convenient way of displaying multiple pages of information,
15b6757b FM	22	displayed one page at a time. wxWidgets has five variants of this control:
36c9828f FM	23
36c9828f FM	24
15b6757b FM	25	#wxNotebook: uses a row of tabs
	26	#wxListbook: controlled by a #wxListCtrl
	27	#wxChoicebook: controlled by a #wxChoice
	28	#wxTreebook: controlled by a #wxTreeCtrl
	29	#wxToolbook: controlled by a #wxToolBar
36c9828f FM	30
36c9828f FM	31
15b6757b	32	See @ref samplenotebook_overview for an example of wxBookCtrl usage.
36c9828f	33
15b6757b	34	@section wxbestbookctrl Best book
36c9828f	35
15b6757b FM	36	wxBookCtrl is mapped to the class best suited for a given platform.
	37	Currently it provides #wxChoicebook for smartphones equipped with
	38	WinCE, and #wxNotebook for all other platforms. The mapping consists of:
36c9828f FM	39
	40
	41
	42
	43
	44
	45
15b6757b	46	wxBookCtrl
36c9828f FM	47
	48
	49
	50
15b6757b	51	wxChoicebook or wxNotebook
36c9828f FM	52
	53
	54
	55
	56
15b6757b	57	wxBookCtrlEvent
36c9828f FM	58
	59
	60
	61
15b6757b	62	wxChoicebookEvent or wxNotebookEvent
36c9828f FM	63
	64
	65
	66
	67
15b6757b	68	wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED
36c9828f FM	69
	70
	71
	72
15b6757b	73	wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
36c9828f FM	74
	75
	76
	77
	78
15b6757b	79	wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING
36c9828f FM	80
	81
	82
	83
15b6757b	84	wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
36c9828f FM	85
	86
	87
	88
	89
15b6757b	90	EVT_BOOKCTRL_PAGE_CHANGED(id, fn)
36c9828f FM	91
	92
	93
	94
15b6757b	95	EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or EVT_NOTEBOOK_PAGE_CHANGED(id, fn)
36c9828f FM	96
	97
	98
	99
	100
15b6757b	101	EVT_BOOKCTRL_PAGE_CHANGING(id, fn)
36c9828f FM	102
	103
	104
	105
15b6757b	106	EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or EVT_NOTEBOOK_PAGE_CHANGING(id, fn)
36c9828f FM	107
	108
	109
	110
	111
15b6757b	112	For orientation of the book controller, use following flags in style:
36c9828f FM	113
	114
	115
	116
	117
	118
	119
15b6757b	120	@b wxBK_TOP
36c9828f FM	121
	122
	123
	124
15b6757b	125	controller above pages
36c9828f FM	126
	127
	128
	129
	130
15b6757b	131	@b wxBK_BOTTOM
36c9828f FM	132
	133
	134
	135
15b6757b	136	controller below pages
36c9828f FM	137
	138
	139
	140
	141
15b6757b	142	@b wxBK_LEFT
36c9828f FM	143
	144
	145
	146
15b6757b	147	controller on the left
36c9828f FM	148
	149
	150
	151
	152
15b6757b	153	@b wxBK_RIGHT
36c9828f FM	154
	155
	156
	157
15b6757b	158	controller on the right
36c9828f FM	159
	160
	161
	162
	163
15b6757b	164	@b wxBK_DEFAULT
36c9828f FM	165
	166
	167
	168
15b6757b	169	native controller placement
36c9828f	170
15b6757b	171	*/
36c9828f FM	172
36c9828f FM	173