docs/latex/wx/notebook.tex

   1 \section{\class{wxNotebook}}\label{wxnotebook}
   2
   3 This class represents a notebook control, which manages multiple windows with associated tabs.
   4
   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
   7 managed 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
  18 \wxheading{Include files}
  19
  20 <wx/notebook.h>
  21
  22 \wxheading{Window styles}
  23
  24 \twocolwidtha{5cm}
  25 \begin{twocollist}\itemsep=0pt
  26
  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.}
  32
  33 \end{twocollist}
  34
  35 See also \helpref{window styles overview}{windowstyles}.
  36
  37 \input noteevt.inc
  38
  39 \wxheading{See also}
  40
  41 \helpref{wxNotebookEvent}{wxnotebookevent}, \helpref{wxImageList}{wximagelist},\rtfsp
  42 \helpref{wxTabCtrl}{wxtabctrl}
  43
  44 \latexignore{\rtfignore{\wxheading{Members}}}
  45
  46 \membersection{wxNotebook::wxNotebook}\label{wxnotebookctor}
  47
  48 \func{}{wxNotebook}{\void}
  49
  50 Default constructor.
  51
  52 \func{}{wxNotebook}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
  53  \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}}
  54
  55 Constructs a notebook control.
  56
  57 Note that sometimes you can reduce flicker by passing the wxCLIP\_CHILDREN window style.
  58
  59 \wxheading{Parameters}
  60
  61 \docparam{parent}{The parent window. Must be non-NULL.}
  62
  63 \docparam{id}{The window identifier.}
  64
  65 \docparam{pos}{The window position.}
  66
  67 \docparam{size}{The window size.}
  68
  69 \docparam{style}{The window style. See \helpref{wxNotebook}{wxnotebook}.}
  70
  71 \docparam{name}{The name of the control (used only under Motif).}
  72
  73 \membersection{wxNotebook::\destruct{wxNotebook}}\label{wxnotebookdtor}
  74
  75 \func{}{\destruct{wxNotebook}}{\void}
  76
  77 Destroys the wxNotebook object.
  78
  79 \membersection{wxNotebook::AddPage}\label{wxnotebookaddpage}
  80
  81 \func{bool}{AddPage}{\param{wxNotebookPage*}{ page},
  82  \param{const wxString\&}{ text},
  83  \param{bool}{ select = false},
  84  \param{int}{ imageId = -1}}
  85
  86 Adds a new page.
  87
  88 The call to this function may generate the page changing events.
  89
  90 \wxheading{Parameters}
  91
  92 \docparam{page}{Specifies the new page.}
  93
  94 \docparam{text}{Specifies the text for the new page.}
  95
  96 \docparam{select}{Specifies whether the page should be selected.}
  97
  98 \docparam{imageId}{Specifies the optional image index for the new page.}
  99
 100 \wxheading{Return value}
 101
 102 true if successful, false otherwise.
 103
 104 \wxheading{Remarks}
 105
 106 Do not delete the page, it will be deleted by the notebook.
 107
 108 \wxheading{See also}
 109
 110 \helpref{wxNotebook::InsertPage}{wxnotebookinsertpage}
 111
 112 \membersection{wxNotebook::AdvanceSelection}\label{wxnotebookadvanceselection}
 113
 114 \func{void}{AdvanceSelection}{\param{bool}{ forward = true}}
 115
 116 Cycles through the tabs.
 117
 118 The call to this function generates the page changing events.
 119
 120 \membersection{wxNotebook::AssignImageList}\label{wxnotebookassignimagelist}
 121
 122 \func{void}{AssignImageList}{\param{wxImageList*}{ imageList}}
 123
 124 Sets the image list for the page control and takes ownership of
 125 the list.
 126
 127 \wxheading{See also}
 128
 129 \helpref{wxImageList}{wximagelist},
 130 \helpref{SetImageList}{wxnotebooksetimagelist}
 131
 132 \membersection{wxNotebook::Create}\label{wxnotebookcreate}
 133
 134 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
 135  \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}}
 136
 137 Creates a notebook control. See \helpref{wxNotebook::wxNotebook}{wxnotebookctor} for a description
 138 of the parameters.
 139
 140 \membersection{wxNotebook::DeleteAllPages}\label{wxnotebookdeleteallpages}
 141
 142 \func{bool}{DeleteAllPages}{\void}
 143
 144 Deletes all pages.
 145
 146 \membersection{wxNotebook::DeletePage}\label{wxnotebookdeletepage}
 147
 148 \func{bool}{DeletePage}{\param{size\_t}{ page}}
 149
 150 Deletes the specified page, and the associated window.
 151
 152 The call to this function generates the page changing events.
 153
 154 \membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist}
 155
 156 \constfunc{wxImageList*}{GetImageList}{\void}
 157
 158 Returns the associated image list.
 159
 160 \wxheading{See also}
 161
 162 \helpref{wxImageList}{wximagelist}, \helpref{wxNotebook::SetImageList}{wxnotebooksetimagelist}
 163
 164 \membersection{wxNotebook::GetPage}\label{wxnotebookgetpage}
 165
 166 \func{wxNotebookPage*}{GetPage}{\param{size\_t}{ page}}
 167
 168 Returns the window at the given page position.
 169
 170 \membersection{wxNotebook::GetPageCount}\label{wxnotebookgetpagecount}
 171
 172 \constfunc{size\_t}{GetPageCount}{\void}
 173
 174 Returns the number of pages in the notebook control.
 175
 176 \membersection{wxNotebook::GetPageImage}\label{wxnotebookgetpageimage}
 177
 178 \constfunc{int}{GetPageImage}{\param{size\_t }{nPage}}
 179
 180 Returns the image index for the given page.
 181
 182 \membersection{wxNotebook::GetPageText}\label{wxnotebookgetpagetext}
 183
 184 \constfunc{wxString}{GetPageText}{\param{size\_t }{nPage}}
 185
 186 Returns the string for the given page.
 187
 188 \membersection{wxNotebook::GetRowCount}\label{wxnotebookgetrowcount}
 189
 190 \constfunc{int}{GetRowCount}{\void}
 191
 192 Returns the number of rows in the notebook control.
 193
 194 \membersection{wxNotebook::GetSelection}\label{wxnotebookgetselection}
 195
 196 \constfunc{int}{GetSelection}{\void}
 197
 198 Returns the currently selected page, or $-1$ if none was selected.
 199
 200 Note that this method may return either the previously or newly selected page
 201 when called from the {\tt EVT\_NOTEBOOK\_PAGE\_CHANGED} handler depending on
 202 the platform and so\rtfsp
 203 \helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection} should be
 204 used instead in this case.
 205
 206 \membersection{wxNotebook::HitTest}\label{wxnotebookhittest}
 207
 208 \func{int}{HitTest}{\param{const wxPoint\&}{ pt}, \param{long}{ *flags = {\tt NULL}}}
 209
 210 Returns the index of the tab at the specified position or {\tt wxNOT\_FOUND}
 211 if none. If {\it flags} parameter is non {\tt NULL}, the position of the point
 212 inside the tab is returned as well.
 213
 214 {\bf NB: } This method is currently only implemented under wxMSW and wxUniv.
 215
 216 \wxheading{Parameters}
 217
 218 \docparam{pt}{Specifies the point for the hit test.}
 219
 220 \docparam{flags}{Return value for detailed information. One of the following values:
 221 \twocolwidtha{7cm}
 222 \begin{twocollist}\itemsep=0pt
 223 \twocolitem{{\bf wxNB\_HITTEST\_NOWHERE}}{There was no tab under this point.}
 224 \twocolitem{{\bf wxNB\_HITTEST\_ONICON}}{The point was over an icon (currently wxMSW only).}
 225 \twocolitem{{\bf wxNB\_HITTEST\_ONLABEL}}{The point was over a label (currently wxMSW only).}
 226 \twocolitem{{\bf wxNB\_HITTEST\_ONITEM}}{The point was over an item, but not on the label or icon.}
 227 \end{twocollist}
 228 }
 229
 230 \wxheading{Return value}
 231
 232 Returns the zero-based tab index or {\tt wxNOT\_FOUND} if there is no tab is at
 233 the specified position.
 234
 235
 236 \membersection{wxNotebook::InsertPage}\label{wxnotebookinsertpage}
 237
 238 \func{bool}{InsertPage}{\param{size\_t}{ index}, \param{wxNotebookPage*}{ page},
 239  \param{const wxString\&}{ text},
 240  \param{bool}{ select = false},
 241  \param{int}{ imageId = -1}}
 242
 243 Inserts a new page at the specified position.
 244
 245 \wxheading{Parameters}
 246
 247 \docparam{index}{Specifies the position for the new page.}
 248
 249 \docparam{page}{Specifies the new page.}
 250
 251 \docparam{text}{Specifies the text for the new page.}
 252
 253 \docparam{select}{Specifies whether the page should be selected.}
 254
 255 \docparam{imageId}{Specifies the optional image index for the new page.}
 256
 257 \wxheading{Return value}
 258
 259 true if successful, false otherwise.
 260
 261 \wxheading{Remarks}
 262
 263 Do not delete the page, it will be deleted by the notebook.
 264
 265 \wxheading{See also}
 266
 267 \helpref{wxNotebook::AddPage}{wxnotebookaddpage}
 268
 269 \membersection{wxNotebook::OnSelChange}\label{wxnotebookonselchange}
 270
 271 \func{void}{OnSelChange}{\param{wxNotebookEvent\&}{ event}}
 272
 273 An event handler function, called when the page selection is changed.
 274
 275 \wxheading{See also}
 276
 277 \helpref{wxNotebookEvent}{wxnotebookevent}
 278
 279 \membersection{wxNotebook::RemovePage}\label{wxnotebookremovepage}
 280
 281 \func{bool}{RemovePage}{\param{size\_t}{ page}}
 282
 283 Deletes the specified page, without deleting the associated window.
 284
 285 \membersection{wxNotebook::SetImageList}\label{wxnotebooksetimagelist}
 286
 287 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
 288
 289 Sets the image list for the page control. It does not take
 290 ownership of the image list, you must delete it yourself.
 291
 292 \wxheading{See also}
 293
 294 \helpref{wxImageList}{wximagelist},
 295 \helpref{AssignImageList}{wxnotebookassignimagelist}
 296
 297 \membersection{wxNotebook::SetPadding}\label{wxnotebooksetpadding}
 298
 299 \func{void}{SetPadding}{\param{const wxSize\&}{ padding}}
 300
 301 Sets the amount of space around each page's icon and label, in pixels.
 302
 303 {\bf NB:} The vertical padding cannot be changed in wxGTK.
 304
 305 \membersection{wxNotebook::SetPageSize}\label{wxnotebooksetpagesize}
 306
 307 \func{void}{SetPageSize}{\param{const wxSize\&}{ size}}
 308
 309 Sets the width and height of the pages.
 310
 311 {\bf NB:} This method is currently not implemented for wxGTK.
 312
 313 \membersection{wxNotebook::SetPageImage}\label{wxnotebooksetpageimage}
 314
 315 \func{bool}{SetPageImage}{\param{size\_t}{ page}, \param{int }{image}}
 316
 317 Sets the image index for the given page. {\it image} is an index into
 318 the image list which was set with \helpref{wxNotebook::SetImageList}{wxnotebooksetimagelist}.
 319
 320 \membersection{wxNotebook::SetPageText}\label{wxnotebooksetpagetext}
 321
 322 \func{bool}{SetPageText}{\param{size\_t}{ page}, \param{const wxString\& }{text}}
 323
 324 Sets the text for the given page.
 325
 326 \membersection{wxNotebook::SetSelection}\label{wxnotebooksetselection}
 327
 328 \func{int}{SetSelection}{\param{size\_t}{ page}}
 329
 330 Sets the selection for the given page, returning the previous selection.
 331
 332 The call to this function generates the page changing events.
 333
 334 \wxheading{See also}
 335
 336 \helpref{wxNotebook::GetSelection}{wxnotebookgetselection}
 337
 338