docs/latex/wx/auinotebook.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % auibook.h at 11/Nov/06 22:56:01
   4 %
   5
   6 \section{\class{wxAuiNotebook}}\label{wxauinotebook}
   7
   8 wxAuiNotebook is part of the wxAUI class framework.
   9 See also \helpref{wxAUI overview}{wxauioverview}.
  10
  11 wxAuiNotebook is a notebook control which implements many features common in applications with dockable panes.
  12 Specifically, wxAuiNotebook implements functionality which allows the user to rearrange tab order via drag-and-drop,
  13 split the tab window into many different splitter configurations, and toggle through different themes to customize
  14 the control's look and feel.
  15
  16 An effort has been made to try to maintain an API as similar to that of wxNotebook.
  17
  18 The default theme that is used is wxAuiDefaultTabArt, which provides a modern, glossy look and feel.
  19 The theme can be changed by calling \helpref{wxAuiNotebook::SetArtProvider}{wxauinotebooksetartprovider}.
  20
  21 \wxheading{Derived from}
  22
  23 \helpref{wxControl}{wxcontrol}
  24
  25 \wxheading{Include files}
  26
  27 <wx/aui/auibook.h>
  28
  29
  30 \wxheading{Window styles}
  31
  32 \twocolwidtha{5cm}%
  33 \begin{twocollist}\itemsep=0pt
  34 \twocolitem{\windowstyle{wxAUI\_NB\_DEFAULT\_STYLE}}{Defined as wxAUI\_NB\_TOP | wxAUI\_NB\_TAB\_SPLIT | wxAUI\_NB\_TAB\_MOVE | wxAUI\_NB\_SCROLL\_BUTTONS | wxAUI\_NB\_CLOSE\_ON\_ACTIVE\_TAB
  35 .}
  36 \twocolitem{\windowstyle{wxAUI\_NB\_TAB\_SPLIT}}{Allows the tab control to be split by dragging a tab.}
  37 \twocolitem{\windowstyle{wxAUI\_NB\_TAB\_MOVE}}{Allows a tab to be moved horizontally by dragging.}
  38 \twocolitem{\windowstyle{wxAUI\_NB\_TAB\_EXTERNAL\_MOVE}}{Allows a tab to be moved to another tab control.}
  39 \twocolitem{\windowstyle{wxAUI\_NB\_TAB\_FIXED\_WIDTH}}{With this style, all tabs have the same width.}
  40 \twocolitem{\windowstyle{wxAUI\_NB\_SCROLL\_BUTTONS}}{With this style, left and right scroll buttons are displayed.}
  41 \twocolitem{\windowstyle{wxAUI\_NB\_WINDOWLIST\_BUTTON}}{With this style, a drop-down list of windows is available.}
  42 \twocolitem{\windowstyle{wxAUI\_NB\_CLOSE\_BUTTON}}{With this style, a close button is available on the tab bar.}
  43 \twocolitem{\windowstyle{wxAUI\_NB\_CLOSE\_ON\_ACTIVE\_TAB}}{With this style, the close button is visible on the active tab.}
  44 \twocolitem{\windowstyle{wxAUI\_NB\_CLOSE\_ON\_ALL\_TABS}}{With this style, the close button is visible on all tabs.}
  45 \end{twocollist}
  46
  47
  48 \wxheading{Data structures}
  49
  50 \latexignore{\rtfignore{\wxheading{Members}}}
  51
  52 \membersection{wxAuiNotebook::wxAuiNotebook}\label{wxauinotebookwxauinotebook}
  53
  54 \func{}{wxAuiNotebook}{\void}
  55
  56 \func{}{wxAuiNotebook}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxAUI\_NB\_DEFAULT\_STYLE}}
  57
  58 Constructor. Creates a wxAuiNotebok control.
  59
  60 \membersection{wxAuiNotebook::AddPage}\label{wxauinotebookaddpage}
  61
  62 \func{bool}{AddPage}{\param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
  63
  64 Adds a page.  If the {\it select} parameter is true, calling this will generate a page change event.
  65
  66 \membersection{wxAuiNotebook::Create}\label{wxauinotebookcreate}
  67
  68 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}}
  69
  70 Creates the notebook window.
  71
  72 \membersection{wxAuiNotebook::DeletePage}\label{wxauinotebookdeletepage}
  73
  74 \func{bool}{DeletePage}{\param{size\_t }{page}}
  75
  76 Deletes a page at the given index.  Calling this method will generate a page change event.
  77
  78 \membersection{wxAuiNotebook::GetArtProvider}\label{wxauinotebookgetartprovider}
  79
  80 \constfunc{wxAuiTabArt*}{GetArtProvider}{\void}
  81
  82 Returns the associated art provider.
  83
  84 \membersection{wxAuiNotebook::GetHeightForPageHeight}\label{wxauinotebookgetheightforpageheight}
  85
  86 \func{int}{GetHeightForPageHeight}{\param{int }{pageHeight}}
  87
  88 Returns the desired height of the notebook for the given page height. Use this to fit the notebook to
  89 a given page size.
  90
  91 \membersection{wxAuiNotebook::GetPage}\label{wxauinotebookgetpage}
  92
  93 \constfunc{wxWindow*}{GetPage}{\param{size\_t }{page\_idx}}
  94
  95 Returns the page specified by the given index.
  96
  97 \membersection{wxAuiNotebook::GetPageBitmap}\label{wxauinotebookgetpagebitmap}
  98
  99 \constfunc{wxBitmap}{GetPageBitmap}{\param{size\_t }{page}}
 100
 101 Returns the tab bitmap for the page.
 102
 103 \membersection{wxAuiNotebook::GetPageCount}\label{wxauinotebookgetpagecount}
 104
 105 \constfunc{size\_t}{GetPageCount}{\void}
 106
 107 Returns the number of pages in the notebook.
 108
 109 \membersection{wxAuiNotebook::GetPageIndex}\label{wxauinotebookgetpageindex}
 110
 111 \constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}}
 112
 113 Returns the page index for the specified window.  If the window is not found in
 114 the notebook, wxNOT\_FOUND is returned.
 115
 116 \membersection{wxAuiNotebook::GetPageText}\label{wxauinotebookgetpagetext}
 117
 118 \constfunc{wxString}{GetPageText}{\param{size\_t }{page}}
 119
 120 Returns the tab label for the page.
 121
 122 \membersection{wxAuiNotebook::GetTabCtrlHeight}\label{wxauinotebookgettabctrlheight}
 123
 124 \constfunc{int}{GetTabCtrlHeight}{\void}
 125
 126 Returns the height of the tab control.
 127
 128 \membersection{wxAuiNotebook::GetSelection}\label{wxauinotebookgetselection}
 129
 130 \constfunc{int}{GetSelection}{\void}
 131
 132 Returns the currently selected page.
 133
 134 \membersection{wxAuiNotebook::GetTabCtrlHeight}\label{wxauinotebookgettabctrlheight}
 135
 136 \constfunc{int}{GetTabCtrlHeight}{\void}
 137
 138 Returns the height of the tab control.
 139
 140 \membersection{wxAuiNotebook::InsertPage}\label{wxauinotebookinsertpage}
 141
 142 \func{bool}{InsertPage}{\param{size\_t }{page\_idx}, \param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
 143
 144 InsertPage() is similar to AddPage, but allows the ability to specify the insert location.
 145 If the {\it select} parameter is true, calling this will generate a page change event.
 146
 147 \membersection{wxAuiNotebook::RemovePage}\label{wxauinotebookremovepage}
 148
 149 \func{bool}{RemovePage}{\param{size\_t }{page}}
 150
 151 Removes a page, without deleting the window pointer.
 152
 153 \membersection{wxAuiNotebook::SetArtProvider}\label{wxauinotebooksetartprovider}
 154
 155 \func{void}{SetArtProvider}{\param{wxAuiTabArt* }{art}}
 156
 157 Sets the art provider to be used by the notebook.
 158
 159 \membersection{wxAuiNotebook::SetFont}\label{wxauinotebooksetfont}
 160
 161 \func{bool}{SetFont}{\param{const wxFont\& }{font}}
 162
 163 Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.
 164
 165 \membersection{wxAuiNotebook::SetNormalFont}\label{wxauinotebooksetnormalfont}
 166
 167 \func{void}{SetNormalFont}{\param{const wxFont\& }{font}}
 168
 169 Sets the font for drawing unselected tab labels.
 170
 171 \membersection{wxAuiNotebook::SetSelectedFont}\label{wxauinotebooksetselectedfont}
 172
 173 \func{void}{SetSelectedFont}{\param{const wxFont\& }{font}}
 174
 175 Sets the font for drawing selected tab labels.
 176
 177 \membersection{wxAuiNotebook::SetMeasuringFont}\label{wxauinotebooksetmeasuringfont}
 178
 179 \func{void}{SetMeasuringFont}{\param{const wxFont\& }{font}}
 180
 181 Sets the font for measuring tab labels.
 182
 183 \membersection{wxAuiNotebook::SetPageBitmap}\label{wxauinotebooksetpagebitmap}
 184
 185 \func{bool}{SetPageBitmap}{\param{size\_t }{page}, \param{const wxBitmap\& }{bitmap}}
 186
 187 Sets the bitmap for the page.  To remove a bitmap from the tab caption, pass
 188 wxNullBitmap.
 189
 190 \membersection{wxAuiNotebook::SetPageText}\label{wxauinotebooksetpagetext}
 191
 192 \func{bool}{SetPageText}{\param{size\_t }{page}, \param{const wxString\& }{text}}
 193
 194 Sets the tab label for the page.
 195
 196 \membersection{wxAuiNotebook::SetSelection}\label{wxauinotebooksetselection}
 197
 198 \func{size\_t}{SetSelection}{\param{size\_t }{new\_page}}
 199
 200 Sets the page selection.  Calling this method will generate a page change event.
 201
 202 \membersection{wxAuiNotebook::SetTabCtrlHeight}\label{wxauinotebooksettabctrlheight}
 203
 204 \func{void}{SetTabCtrlHeight}{\param{int }{height}}
 205
 206 Sets the tab height.  By default, the tab control height is calculated
 207 by measuring the text height and bitmap sizes on the tab captions.  Calling this
 208 method will override that calculation and set the tab control to the specified
 209 height parameter.  A call to this method will override any call to SetUniformBitmapSize().
 210 Specifying -1 as the height will return the control to its default auto-sizing behaviour.
 211
 212 \membersection{wxAuiNotebook::SetUniformBitmapSize}\label{wxauinotebooksetuniformbitmapsize}
 213
 214 \func{void}{SetUniformBitmapSize}{\param{const wxSize\& }{size}}
 215
 216 SetUniformBitmapSize() ensures that all tabs will have the same height, even
 217 if some tabs don't have bitmaps.  Passing wxDefaultSize to this function will
 218 instruct the control to use dynamic tab height, which is the default behaviour.
 219 Under the default behaviour, when a tab with a large bitmap is added, the tab control's
 220 height will automatically increase to accommodate the larger bitmap.
 221
 222 \func{void}{Split}{\param{size\_t }{page}, \param{int }{direction}}
 223
 224 Split performs a split operation programmatically. The argument \arg{page} indicates
 225 the page that will be split off.  This page will also become the active page after the
 226 split.  The \arg{direction} argument specifies where the pane should go, it should be one
 227 of the following: wxTOP, wxBOTTOM, wxLEFT, or wxRIGHT.
 228
 229
 230
 231
 232