1 \section{\class{wxNotebook
}}\label{wxnotebook
}
3 This class represents a notebook control, which manages multiple windows with associated tabs.
5 To use the class, create a wxNotebook object and call
\helpref{AddPage
}{wxnotebookaddpage
} or
\helpref{InsertPage
}{wxnotebookinsertpage
},
6 passing a window to be used as the page. Do not explicitly delete the window for a page that is currently
9 {\bf wxNotebookPage
} is a typedef for wxWindow.
11 \wxheading{Derived from
}
13 \helpref{wxControl
}{wxcontrol
}\\
14 \helpref{wxWindow
}{wxwindow
}\\
15 \helpref{wxEvtHandler
}{wxevthandler
}\\
16 \helpref{wxObject
}{wxobject
}
18 \wxheading{Include files
}
22 \wxheading{Window styles
}
25 \begin{twocollist
}\itemsep=
0pt
27 \twocolitem{\windowstyle{wxNB
\_LEFT}}{Place tabs on the left side. Not supported under Windows XP.
}
28 \twocolitem{\windowstyle{wxNB
\_RIGHT}}{Place tabs on the right side. Not supported under Windows XP.
}
29 \twocolitem{\windowstyle{wxNB
\_BOTTOM}}{Place tabs under instead of above the notebook pages. Not supported under Windows XP.
}
30 \twocolitem{\windowstyle{wxNB
\_FIXEDWIDTH}}{(Windows only) All tabs will have same width.
}
31 \twocolitem{\windowstyle{wxNB
\_MULTILINE}}{(Windows only) There can be several rows of tabs.
}
35 See also
\helpref{window styles overview
}{windowstyles
}.
41 \helpref{wxNotebookEvent
}{wxnotebookevent
},
\helpref{wxImageList
}{wximagelist
},
\rtfsp
42 \helpref{wxTabCtrl
}{wxtabctrl
}
44 \latexignore{\rtfignore{\wxheading{Members
}}}
47 \membersection{wxNotebook::wxNotebook
}\label{wxnotebookctor
}
49 \func{}{wxNotebook
}{\void}
53 \func{}{wxNotebook
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
\param{const wxPoint\&
}{ pos = wxDefaultPosition
},
54 \param{const wxSize\&
}{ size = wxDefaultSize
},
\param{long
}{ style =
0},
\param{const wxString\&
}{name = "notebook"
}}
56 Constructs a notebook control.
58 Note that sometimes you can reduce flicker by passing the wxCLIP
\_CHILDREN window style.
60 \wxheading{Parameters
}
62 \docparam{parent
}{The parent window. Must be non-NULL.
}
64 \docparam{id
}{The window identifier.
}
66 \docparam{pos
}{The window position.
}
68 \docparam{size
}{The window size.
}
70 \docparam{style
}{The window style. See
\helpref{wxNotebook
}{wxnotebook
}.
}
72 \docparam{name
}{The name of the control (used only under Motif).
}
75 \membersection{wxNotebook::
\destruct{wxNotebook
}}\label{wxnotebookdtor
}
77 \func{}{\destruct{wxNotebook
}}{\void}
79 Destroys the wxNotebook object.
82 \membersection{wxNotebook::AddPage
}\label{wxnotebookaddpage
}
84 \func{bool
}{AddPage
}{\param{wxNotebookPage*
}{ page
},
85 \param{const wxString\&
}{ text
},
86 \param{bool
}{ select = false
},
87 \param{int
}{ imageId = -
1}}
91 The call to this function may generate the page changing events.
93 \wxheading{Parameters
}
95 \docparam{page
}{Specifies the new page.
}
97 \docparam{text
}{Specifies the text for the new page.
}
99 \docparam{select
}{Specifies whether the page should be selected.
}
101 \docparam{imageId
}{Specifies the optional image index for the new page.
}
103 \wxheading{Return value
}
105 true if successful, false otherwise.
109 Do not delete the page, it will be deleted by the notebook.
113 \helpref{wxNotebook::InsertPage
}{wxnotebookinsertpage
}
116 \membersection{wxNotebook::AdvanceSelection
}\label{wxnotebookadvanceselection
}
118 \func{void
}{AdvanceSelection
}{\param{bool
}{ forward = true
}}
120 Cycles through the tabs.
122 The call to this function generates the page changing events.
125 \membersection{wxNotebook::AssignImageList
}\label{wxnotebookassignimagelist
}
127 \func{void
}{AssignImageList
}{\param{wxImageList*
}{ imageList
}}
129 Sets the image list for the page control and takes ownership of
134 \helpref{wxImageList
}{wximagelist
},
135 \helpref{SetImageList
}{wxnotebooksetimagelist
}
138 \membersection{wxNotebook::Create
}\label{wxnotebookcreate
}
140 \func{bool
}{Create
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
\param{const wxPoint\&
}{ pos = wxDefaultPosition
},
141 \param{const wxSize\&
}{ size
},
\param{long
}{ style =
0},
\param{const wxString\&
}{name = "notebook"
}}
143 Creates a notebook control. See
\helpref{wxNotebook::wxNotebook
}{wxnotebookctor
} for a description
147 \membersection{wxNotebook::DeleteAllPages
}\label{wxnotebookdeleteallpages
}
149 \func{bool
}{DeleteAllPages
}{\void}
154 \membersection{wxNotebook::DeletePage
}\label{wxnotebookdeletepage
}
156 \func{bool
}{DeletePage
}{\param{size
\_t}{ page
}}
158 Deletes the specified page, and the associated window.
160 The call to this function generates the page changing events.
163 \membersection{wxNotebook::GetCurrentPage
}\label{wxnotebookgetcurrentpage
}
165 \constfunc{wxWindow *
}{GetCurrentPage
}{\void}
167 Returns the currently selected notebook age or
\texttt{NULL
}.
170 \membersection{wxNotebook::GetImageList
}\label{wxnotebookgetimagelist
}
172 \constfunc{wxImageList*
}{GetImageList
}{\void}
174 Returns the associated image list.
178 \helpref{wxImageList
}{wximagelist
},
\helpref{wxNotebook::SetImageList
}{wxnotebooksetimagelist
}
181 \membersection{wxNotebook::GetPage
}\label{wxnotebookgetpage
}
183 \func{wxNotebookPage*
}{GetPage
}{\param{size
\_t}{ page
}}
185 Returns the window at the given page position.
188 \membersection{wxNotebook::GetPageCount
}\label{wxnotebookgetpagecount
}
190 \constfunc{size
\_t}{GetPageCount
}{\void}
192 Returns the number of pages in the notebook control.
195 \membersection{wxNotebook::GetPageImage
}\label{wxnotebookgetpageimage
}
197 \constfunc{int
}{GetPageImage
}{\param{size
\_t }{nPage
}}
199 Returns the image index for the given page.
202 \membersection{wxNotebook::GetPageText
}\label{wxnotebookgetpagetext
}
204 \constfunc{wxString
}{GetPageText
}{\param{size
\_t }{nPage
}}
206 Returns the string for the given page.
209 \membersection{wxNotebook::GetRowCount
}\label{wxnotebookgetrowcount
}
211 \constfunc{int
}{GetRowCount
}{\void}
213 Returns the number of rows in the notebook control.
216 \membersection{wxNotebook::GetSelection
}\label{wxnotebookgetselection
}
218 \constfunc{int
}{GetSelection
}{\void}
220 Returns the currently selected page, or $-
1$ if none was selected.
222 Note that this method may return either the previously or newly selected page
223 when called from the
{\tt EVT
\_NOTEBOOK\_PAGE\_CHANGED} handler depending on
224 the platform and so
\rtfsp
225 \helpref{wxNotebookEvent::GetSelection
}{wxnotebookeventgetselection
} should be
226 used instead in this case.
229 \membersection{wxNotebook::HitTest
}\label{wxnotebookhittest
}
231 \func{int
}{HitTest
}{\param{const wxPoint\&
}{ pt
},
\param{long
}{ *flags =
{\tt NULL
}}}
233 Returns the index of the tab at the specified position or
{\tt wxNOT
\_FOUND}
234 if none. If
{\it flags
} parameter is non
{\tt NULL
}, the position of the point
235 inside the tab is returned as well.
237 {\bf NB:
} This method is currently only implemented under wxMSW and wxUniv.
239 \wxheading{Parameters
}
241 \docparam{pt
}{Specifies the point for the hit test.
}
243 \docparam{flags
}{Return value for detailed information. One of the following values:
245 \begin{twocollist
}\itemsep=
0pt
246 \twocolitem{{\bf wxNB
\_HITTEST\_NOWHERE}}{There was no tab under this point.
}
247 \twocolitem{{\bf wxNB
\_HITTEST\_ONICON}}{The point was over an icon (currently wxMSW only).
}
248 \twocolitem{{\bf wxNB
\_HITTEST\_ONLABEL}}{The point was over a label (currently wxMSW only).
}
249 \twocolitem{{\bf wxNB
\_HITTEST\_ONITEM}}{The point was over an item, but not on the label or icon.
}
253 \wxheading{Return value
}
255 Returns the zero-based tab index or
{\tt wxNOT
\_FOUND} if there is no tab is at
256 the specified position.
260 \membersection{wxNotebook::InsertPage
}\label{wxnotebookinsertpage
}
262 \func{bool
}{InsertPage
}{\param{size
\_t}{ index
},
\param{wxNotebookPage*
}{ page
},
263 \param{const wxString\&
}{ text
},
264 \param{bool
}{ select = false
},
265 \param{int
}{ imageId = -
1}}
267 Inserts a new page at the specified position.
269 \wxheading{Parameters
}
271 \docparam{index
}{Specifies the position for the new page.
}
273 \docparam{page
}{Specifies the new page.
}
275 \docparam{text
}{Specifies the text for the new page.
}
277 \docparam{select
}{Specifies whether the page should be selected.
}
279 \docparam{imageId
}{Specifies the optional image index for the new page.
}
281 \wxheading{Return value
}
283 true if successful, false otherwise.
287 Do not delete the page, it will be deleted by the notebook.
291 \helpref{wxNotebook::AddPage
}{wxnotebookaddpage
}
294 \membersection{wxNotebook::OnSelChange
}\label{wxnotebookonselchange
}
296 \func{void
}{OnSelChange
}{\param{wxNotebookEvent\&
}{ event
}}
298 An event handler function, called when the page selection is changed.
302 \helpref{wxNotebookEvent
}{wxnotebookevent
}
305 \membersection{wxNotebook::RemovePage
}\label{wxnotebookremovepage
}
307 \func{bool
}{RemovePage
}{\param{size
\_t}{ page
}}
309 Deletes the specified page, without deleting the associated window.
312 \membersection{wxNotebook::SetImageList
}\label{wxnotebooksetimagelist
}
314 \func{void
}{SetImageList
}{\param{wxImageList*
}{ imageList
}}
316 Sets the image list for the page control. It does not take
317 ownership of the image list, you must delete it yourself.
321 \helpref{wxImageList
}{wximagelist
},
322 \helpref{AssignImageList
}{wxnotebookassignimagelist
}
325 \membersection{wxNotebook::SetPadding
}\label{wxnotebooksetpadding
}
327 \func{void
}{SetPadding
}{\param{const wxSize\&
}{ padding
}}
329 Sets the amount of space around each page's icon and label, in pixels.
331 {\bf NB:
} The vertical padding cannot be changed in wxGTK.
334 \membersection{wxNotebook::SetPageSize
}\label{wxnotebooksetpagesize
}
336 \func{void
}{SetPageSize
}{\param{const wxSize\&
}{ size
}}
338 Sets the width and height of the pages.
340 {\bf NB:
} This method is currently not implemented for wxGTK.
343 \membersection{wxNotebook::SetPageImage
}\label{wxnotebooksetpageimage
}
345 \func{bool
}{SetPageImage
}{\param{size
\_t}{ page
},
\param{int
}{image
}}
347 Sets the image index for the given page.
{\it image
} is an index into
348 the image list which was set with
\helpref{wxNotebook::SetImageList
}{wxnotebooksetimagelist
}.
351 \membersection{wxNotebook::SetPageText
}\label{wxnotebooksetpagetext
}
353 \func{bool
}{SetPageText
}{\param{size
\_t}{ page
},
\param{const wxString\&
}{text
}}
355 Sets the text for the given page.
358 \membersection{wxNotebook::SetSelection
}\label{wxnotebooksetselection
}
360 \func{int
}{SetSelection
}{\param{size
\_t}{ page
}}
362 Sets the selection for the given page, returning the previous selection.
364 The call to this function generates the page changing events.
368 \helpref{wxNotebook::GetSelection
}{wxnotebookgetselection
}