]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/notebook.tex
wxPerl documentation updates
[wxWidgets.git] / docs / latex / wx / notebook.tex
CommitLineData
3972fb49
JS
1\section{\class{wxNotebook}}\label{wxnotebook}
2
3This class represents a notebook control, which manages multiple windows with associated tabs.
4
5To use the class, create a wxNotebook object and call \helpref{AddPage}{wxnotebookaddpage} or \helpref{InsertPage}{wxnotebookinsertpage},
6passing a window to be used as the page. Do not explicitly delete the window for a page that is currently
7managed by wxNotebook.
8
9{\bf wxNotebookPage} is a typedef for wxWindow.
10
11\wxheading{Derived from}
12
13\helpref{wxControl}{wxcontrol}\\
14\helpref{wxWindow}{wxwindow}\\
15\helpref{wxEvtHandler}{wxevthandler}\\
16\helpref{wxObject}{wxobject}
17
954b8ae6
JS
18\wxheading{Include files}
19
20<wx/notebook.h>
21
da27bd0b
VZ
22\wxheading{Window styles}
23
24\twocolwidtha{5cm}
25\begin{twocollist}\itemsep=0pt
f6bcfd97
BP
26
27\twocolitem{\windowstyle{wxNB\_FIXEDWIDTH}}{(Windows only)All tabs will have same width.}
28\twocolitem{\windowstyle{wxNB\_LEFT}}{Place tabs on the left side.}
29\twocolitem{\windowstyle{wxNB\_RIGHT}}{Place tabs on the right side.}
30\twocolitem{\windowstyle{wxNB\_BOTTOM}}{Place tabs under instead of above the notebook pages.}
31
da27bd0b
VZ
32\end{twocollist}
33
f6bcfd97
BP
34See also \helpref{window styles overview}{windowstyles}.
35
1d2bd847 36\input noteevt.inc
3972fb49
JS
37
38\wxheading{See also}
39
40\helpref{wxNotebookEvent}{wxnotebookevent}, \helpref{wxImageList}{wximagelist},\rtfsp
41\helpref{wxTabCtrl}{wxtabctrl}
42
43\latexignore{\rtfignore{\wxheading{Members}}}
44
45\membersection{wxNotebook::wxNotebook}\label{wxnotebookconstr}
46
47\func{}{wxNotebook}{\void}
48
49Default constructor.
50
51\func{}{wxNotebook}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
52 \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}}
53
54Constructs a notebook control.
55
5fa399c9
JS
56Note that sometimes you can reduce flicker by passing the wxCLIP\_CHILDREN window style.
57
3972fb49
JS
58\wxheading{Parameters}
59
60\docparam{parent}{The parent window. Must be non-NULL.}
61
62\docparam{id}{The window identifier.}
63
64\docparam{pos}{The window position.}
65
66\docparam{size}{The window size.}
67
f6bcfd97 68\docparam{style}{The window style. See \helpref{wxNotebook}{wxnotebook}.}
3972fb49 69
8c517ddd
VZ
70\docparam{name}{The name of the control (used only under Motif).}
71
3972fb49
JS
72\membersection{wxNotebook::\destruct{wxNotebook}}
73
74\func{}{\destruct{wxNotebook}}{\void}
75
76Destroys the wxNotebook object.
77
78\membersection{wxNotebook::AddPage}\label{wxnotebookaddpage}
79
80\func{bool}{AddPage}{\param{wxNotebookPage*}{ page},
81 \param{const wxString\&}{ text},
82 \param{bool}{ select = FALSE},
83 \param{int}{ imageId = -1}}
84
85Adds a new page.
86
87\wxheading{Parameters}
88
89\docparam{page}{Specifies the new page.}
90
91\docparam{text}{Specifies the text for the new page.}
92
93\docparam{select}{Specifies whether the page should be selected.}
94
95\docparam{imageId}{Specifies the optional image index for the new page.}
96
97\wxheading{Return value}
98
99TRUE if successful, FALSE otherwise.
100
101\wxheading{Remarks}
102
103Do not delete the page, it will be deleted by the notebook.
104
105\wxheading{See also}
106
107\helpref{wxNotebook::InsertPage}{wxnotebookinsertpage}
108
109\membersection{wxNotebook::AdvanceSelection}\label{wxnotebookadvanceselection}
110
111\func{void}{AdvanceSelection}{\param{bool}{ forward = TRUE}}
112
113Cycles through the tabs.
114
b656febd
VS
115\membersection{wxNotebook::AssignImageList}\label{wxnotebookassignimagelist}
116
117\func{void}{AssignImageList}{\param{wxImageList*}{ imageList}}
118
119Sets the image list for the page control and takes ownership of
120the list.
121
122\wxheading{See also}
123
124\helpref{wxImageList}{wximagelist},
125\helpref{SetImageList}{wxnotebooksetimagelist}
126
3972fb49
JS
127\membersection{wxNotebook::Create}\label{wxnotebookcreate}
128
129\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
130 \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}}
131
132Creates a notebook control. See \helpref{wxNotebook::wxNotebook}{wxnotebookconstr} for a description
133of the parameters.
134
135\membersection{wxNotebook::DeleteAllPages}\label{wxnotebookdeleteallpages}
136
137\func{bool}{DeleteAllPages}{\void}
138
139Deletes all pages.
140
141\membersection{wxNotebook::DeletePage}\label{wxnotebookdeletepage}
142
143\func{bool}{DeletePage}{\param{int}{ page}}
144
621793f4 145Deletes the specified page, and the associated window.
3972fb49
JS
146
147\membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist}
148
149\constfunc{wxImageList*}{GetImageList}{\void}
150
151Returns the associated image list.
152
153\wxheading{See also}
154
155\helpref{wxImageList}{wximagelist}, \helpref{wxNotebook::SetImageList}{wxnotebooksetimagelist}
156
157\membersection{wxNotebook::GetPage}\label{wxnotebookgetpage}
158
159\func{wxNotebookPage*}{GetPage}{\param{int}{ page}}
160
161Returns the window at the given page position.
162
163\membersection{wxNotebook::GetPageCount}\label{wxnotebookgetpagecount}
164
165\constfunc{int}{GetPageCount}{\void}
166
167Returns the number of pages in the notebook control.
168
169\membersection{wxNotebook::GetPageImage}\label{wxnotebookgetpageimage}
170
f6bcfd97 171\constfunc{int}{GetPageImage}{\param{int }{nPage}}
3972fb49
JS
172
173Returns the image index for the given page.
174
175\membersection{wxNotebook::GetPageText}\label{wxnotebookgetpagetext}
176
f6bcfd97 177\constfunc{wxString}{GetPageText}{\param{int }{nPage}}
3972fb49
JS
178
179Returns the string for the given page.
180
181\membersection{wxNotebook::GetRowCount}\label{wxnotebookgetrowcount}
182
183\constfunc{int}{GetRowCount}{\void}
184
185Returns the number of rows in the notebook control.
186
187\membersection{wxNotebook::GetSelection}\label{wxnotebookgetselection}
188
189\constfunc{int}{GetSelection}{\void}
190
191Returns the currently selected page, or -1 if none was selected.
192
193\membersection{wxNotebook::InsertPage}\label{wxnotebookinsertpage}
194
195\func{bool}{InsertPage}{\param{int}{ index}, \param{wxNotebookPage*}{ page},
196 \param{const wxString\&}{ text},
197 \param{bool}{ select = FALSE},
198 \param{int}{ imageId = -1}}
199
200Inserts a new page at the specified position.
201
202\wxheading{Parameters}
203
204\docparam{index}{Specifies the position for the new page.}
205
206\docparam{page}{Specifies the new page.}
207
208\docparam{text}{Specifies the text for the new page.}
209
210\docparam{select}{Specifies whether the page should be selected.}
211
212\docparam{imageId}{Specifies the optional image index for the new page.}
213
214\wxheading{Return value}
215
216TRUE if successful, FALSE otherwise.
217
218\wxheading{Remarks}
219
220Do not delete the page, it will be deleted by the notebook.
221
222\wxheading{See also}
223
224\helpref{wxNotebook::AddPage}{wxnotebookaddpage}
225
226\membersection{wxNotebook::OnSelChange}\label{wxnotebookonselchange}
227
228\func{void}{OnSelChange}{\param{wxNotebookEvent\&}{ event}}
229
230An event handler function, called when the page selection is changed.
231
232\wxheading{See also}
233
234\helpref{wxNotebookEvent}{wxnotebookevent}
235
621793f4
JS
236\membersection{wxNotebook::RemovePage}\label{wxnotebookremovepage}
237
238\func{bool}{RemovePage}{\param{int}{ page}}
239
240Deletes the specified page, without deleting the associated window.
241
3972fb49
JS
242\membersection{wxNotebook::SetImageList}\label{wxnotebooksetimagelist}
243
244\func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
245
b656febd
VS
246Sets the image list for the page control. It does not take
247ownership of the image list, you must delete it yourself.
3972fb49
JS
248
249\wxheading{See also}
250
b656febd
VS
251\helpref{wxImageList}{wximagelist},
252\helpref{AssignImageList}{wxnotebookassignimagelist}
3972fb49
JS
253
254\membersection{wxNotebook::SetPadding}\label{wxnotebooksetpadding}
255
256\func{void}{SetPadding}{\param{const wxSize\&}{ padding}}
257
258Sets the amount of space around each page's icon and label, in pixels.
259
260\membersection{wxNotebook::SetPageSize}\label{wxnotebooksetpagesize}
261
262\func{void}{SetPageSize}{\param{const wxSize\&}{ size}}
263
264Sets the width and height of the pages.
265
266\membersection{wxNotebook::SetPageImage}\label{wxnotebooksetpageimage}
267
268\func{bool}{SetPageImage}{\param{int}{ page}, \param{int }{image}}
269
270Sets the image index for the given page. {\it image} is an index into
271the image list which was set with \helpref{wxNotebook::SetImageList}{wxnotebooksetimagelist}.
272
273\membersection{wxNotebook::SetPageText}\label{wxnotebooksetpagetext}
274
275\func{bool}{SetPageText}{\param{int}{ page}, \param{const wxString\& }{text}}
276
277Sets the text for the given page.
278
279\membersection{wxNotebook::SetSelection}\label{wxnotebooksetselection}
280
281\func{int}{SetSelection}{\param{int}{ page}}
282
283Sets the selection for the given page, returning the previous selection.
284
285\wxheading{See also}
286
287\helpref{wxNotebook::GetSelection}{wxnotebookgetselection}
288
289