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\_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
  32 \end{twocollist}
  33
  34 See also \helpref{window styles overview}{windowstyles}.
  35
  36 \input noteevt.inc
  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
  49 Default constructor.
  50
  51 \func{}{wxNotebook}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
  52  \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}}
  53
  54 Constructs a notebook control.
  55
  56 Note that sometimes you can reduce flicker by passing the wxCLIP\_CHILDREN window style.
  57
  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
  68 \docparam{style}{The window style. See \helpref{wxNotebook}{wxnotebook}.}
  69
  70 \docparam{name}{The name of the control (used only under Motif).}
  71
  72 \membersection{wxNotebook::\destruct{wxNotebook}}
  73
  74 \func{}{\destruct{wxNotebook}}{\void}
  75
  76 Destroys 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
  85 Adds 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
  99 TRUE if successful, FALSE otherwise.
 100
 101 \wxheading{Remarks}
 102
 103 Do 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
 113 Cycles through the tabs.
 114
 115 \membersection{wxNotebook::AssignImageList}\label{wxnotebookassignimagelist}
 116
 117 \func{void}{AssignImageList}{\param{wxImageList*}{ imageList}}
 118
 119 Sets the image list for the page control and takes ownership of
 120 the list.
 121
 122 \wxheading{See also}
 123
 124 \helpref{wxImageList}{wximagelist},
 125 \helpref{SetImageList}{wxnotebooksetimagelist}
 126
 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
 132 Creates a notebook control. See \helpref{wxNotebook::wxNotebook}{wxnotebookconstr} for a description
 133 of the parameters.
 134
 135 \membersection{wxNotebook::DeleteAllPages}\label{wxnotebookdeleteallpages}
 136
 137 \func{bool}{DeleteAllPages}{\void}
 138
 139 Deletes all pages.
 140
 141 \membersection{wxNotebook::DeletePage}\label{wxnotebookdeletepage}
 142
 143 \func{bool}{DeletePage}{\param{int}{ page}}
 144
 145 Deletes the specified page, and the associated window.
 146
 147 \membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist}
 148
 149 \constfunc{wxImageList*}{GetImageList}{\void}
 150
 151 Returns 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
 161 Returns the window at the given page position.
 162
 163 \membersection{wxNotebook::GetPageCount}\label{wxnotebookgetpagecount}
 164
 165 \constfunc{int}{GetPageCount}{\void}
 166
 167 Returns the number of pages in the notebook control.
 168
 169 \membersection{wxNotebook::GetPageImage}\label{wxnotebookgetpageimage}
 170
 171 \constfunc{int}{GetPageImage}{\param{int }{nPage}}
 172
 173 Returns the image index for the given page.
 174
 175 \membersection{wxNotebook::GetPageText}\label{wxnotebookgetpagetext}
 176
 177 \constfunc{wxString}{GetPageText}{\param{int }{nPage}}
 178
 179 Returns the string for the given page.
 180
 181 \membersection{wxNotebook::GetRowCount}\label{wxnotebookgetrowcount}
 182
 183 \constfunc{int}{GetRowCount}{\void}
 184
 185 Returns the number of rows in the notebook control.
 186
 187 \membersection{wxNotebook::GetSelection}\label{wxnotebookgetselection}
 188
 189 \constfunc{int}{GetSelection}{\void}
 190
 191 Returns the currently selected page, or $-1$ if none was selected.
 192
 193 Note that this method may return either the previously or newly selected page
 194 when called from the {\tt EVT\_NOTEBOOK\_PAGE\_CHANGED} handler depending on
 195 the platform and so\rtfsp
 196 \helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection} should be
 197 used instead in this case.
 198
 199 \membersection{wxNotebook::InsertPage}\label{wxnotebookinsertpage}
 200
 201 \func{bool}{InsertPage}{\param{int}{ index}, \param{wxNotebookPage*}{ page},
 202  \param{const wxString\&}{ text},
 203  \param{bool}{ select = FALSE},
 204  \param{int}{ imageId = -1}}
 205
 206 Inserts a new page at the specified position.
 207
 208 \wxheading{Parameters}
 209
 210 \docparam{index}{Specifies the position for the new page.}
 211
 212 \docparam{page}{Specifies the new page.}
 213
 214 \docparam{text}{Specifies the text for the new page.}
 215
 216 \docparam{select}{Specifies whether the page should be selected.}
 217
 218 \docparam{imageId}{Specifies the optional image index for the new page.}
 219
 220 \wxheading{Return value}
 221
 222 TRUE if successful, FALSE otherwise.
 223
 224 \wxheading{Remarks}
 225
 226 Do not delete the page, it will be deleted by the notebook.
 227
 228 \wxheading{See also}
 229
 230 \helpref{wxNotebook::AddPage}{wxnotebookaddpage}
 231
 232 \membersection{wxNotebook::OnSelChange}\label{wxnotebookonselchange}
 233
 234 \func{void}{OnSelChange}{\param{wxNotebookEvent\&}{ event}}
 235
 236 An event handler function, called when the page selection is changed.
 237
 238 \wxheading{See also}
 239
 240 \helpref{wxNotebookEvent}{wxnotebookevent}
 241
 242 \membersection{wxNotebook::RemovePage}\label{wxnotebookremovepage}
 243
 244 \func{bool}{RemovePage}{\param{int}{ page}}
 245
 246 Deletes the specified page, without deleting the associated window.
 247
 248 \membersection{wxNotebook::SetImageList}\label{wxnotebooksetimagelist}
 249
 250 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
 251
 252 Sets the image list for the page control. It does not take
 253 ownership of the image list, you must delete it yourself.
 254
 255 \wxheading{See also}
 256
 257 \helpref{wxImageList}{wximagelist},
 258 \helpref{AssignImageList}{wxnotebookassignimagelist}
 259
 260 \membersection{wxNotebook::SetPadding}\label{wxnotebooksetpadding}
 261
 262 \func{void}{SetPadding}{\param{const wxSize\&}{ padding}}
 263
 264 Sets the amount of space around each page's icon and label, in pixels.
 265
 266 {\bf NB:} The vertical padding cannot be changed in wxGTK.
 267
 268 \membersection{wxNotebook::SetPageSize}\label{wxnotebooksetpagesize}
 269
 270 \func{void}{SetPageSize}{\param{const wxSize\&}{ size}}
 271
 272 Sets the width and height of the pages.
 273
 274 {\bf NB:} This method is currently not implemented for wxGTK.
 275
 276 \membersection{wxNotebook::SetPageImage}\label{wxnotebooksetpageimage}
 277
 278 \func{bool}{SetPageImage}{\param{int}{ page}, \param{int }{image}}
 279
 280 Sets the image index for the given page. {\it image} is an index into
 281 the image list which was set with \helpref{wxNotebook::SetImageList}{wxnotebooksetimagelist}.
 282
 283 \membersection{wxNotebook::SetPageText}\label{wxnotebooksetpagetext}
 284
 285 \func{bool}{SetPageText}{\param{int}{ page}, \param{const wxString\& }{text}}
 286
 287 Sets the text for the given page.
 288
 289 \membersection{wxNotebook::SetSelection}\label{wxnotebooksetselection}
 290
 291 \func{int}{SetSelection}{\param{int}{ page}}
 292
 293 Sets the selection for the given page, returning the previous selection.
 294
 295 \wxheading{See also}
 296
 297 \helpref{wxNotebook::GetSelection}{wxnotebookgetselection}
 298
 299