2 % automatically generated by HelpGen $Revision$ from
3 % auibook.h at 11/Nov/06 22:56:01
6 \section{\class{wxAuiNotebook
}}\label{wxauinotebook
}
8 wxAuiNotebook is part of the wxAUI class framework.
9 See also
\helpref{wxAUI overview
}{wxauioverview
}.
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.
16 An effort has been made to try to maintain an API as similar to that of wxNotebook.
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
}.
21 \wxheading{Derived from
}
23 \helpref{wxControl
}{wxcontrol
}\\
24 \helpref{wxWindow
}{wxwindow
}\\
25 \helpref{wxEvtHandler
}{wxevthandler
}\\
26 \helpref{wxObject
}{wxobject
}
28 \wxheading{Include files
}
34 \helpref{wxAui
}{librarieslist
}
37 \wxheading{Window styles
}
40 \begin{twocollist
}\itemsep=
0pt
41 \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.
}
42 \twocolitem{\windowstyle{wxAUI
\_NB\_TAB\_SPLIT}}{Allows the tab control to be split by dragging a tab.
}
43 \twocolitem{\windowstyle{wxAUI
\_NB\_TAB\_MOVE}}{Allows a tab to be moved horizontally by dragging.
}
44 \twocolitem{\windowstyle{wxAUI
\_NB\_TAB\_EXTERNAL\_MOVE}}{Allows a tab to be moved to another tab control.
}
45 \twocolitem{\windowstyle{wxAUI
\_NB\_TAB\_FIXED\_WIDTH}}{With this style, all tabs have the same width.
}
46 \twocolitem{\windowstyle{wxAUI
\_NB\_SCROLL\_BUTTONS}}{With this style, left and right scroll buttons are displayed.
}
47 \twocolitem{\windowstyle{wxAUI
\_NB\_WINDOWLIST\_BUTTON}}{With this style, a drop-down list of windows is available.
}
48 \twocolitem{\windowstyle{wxAUI
\_NB\_CLOSE\_BUTTON}}{With this style, a close button is available on the tab bar.
}
49 \twocolitem{\windowstyle{wxAUI
\_NB\_CLOSE\_ON\_ACTIVE\_TAB}}{With this style, the close button is visible on the active tab.
}
50 \twocolitem{\windowstyle{wxAUI
\_NB\_CLOSE\_ON\_ALL\_TABS}}{With this style, the close button is visible on all tabs.
}
51 \twocolitem{\windowstyle{wxAUI
\_NB\_TOP}}{With this style, tabs are drawn along the top of the notebook.
}
52 \twocolitem{\windowstyle{wxAUI
\_NB\_BOTTOM}}{With this style, tabs are drawn along the bottom of the notebook.
}
56 \wxheading{Data structures
}
58 \latexignore{\rtfignore{\wxheading{Members
}}}
60 \membersection{wxAuiNotebook::wxAuiNotebook
}\label{wxauinotebookwxauinotebook
}
62 \func{}{wxAuiNotebook
}{\void}
64 \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}}
66 Constructor. Creates a wxAuiNotebok control.
68 \membersection{wxAuiNotebook::AddPage
}\label{wxauinotebookaddpage
}
70 \func{bool
}{AddPage
}{\param{wxWindow*
}{page
},
\param{const wxString\&
}{caption
},
\param{bool
}{select = false
},
\param{const wxBitmap\&
}{bitmap = wxNullBitmap
}}
72 Adds a page. If the
{\it select
} parameter is true, calling this will generate a page change event.
74 \membersection{wxAuiNotebook::AdvanceSelection
}\label{wxauinotebookadvanceselection
}
76 \func{void
}{AdvanceSelection
}{\param{bool
}{forward = true
}}
78 Sets the selection to the next or previous page.
80 \membersection{wxAuiNotebook::Create
}\label{wxauinotebookcreate
}
82 \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}}
84 Creates the notebook window.
86 \membersection{wxAuiNotebook::DeletePage
}\label{wxauinotebookdeletepage
}
88 \func{bool
}{DeletePage
}{\param{size
\_t }{page
}}
90 Deletes a page at the given index. Calling this method will generate a page change event.
92 \membersection{wxAuiNotebook::GetArtProvider
}\label{wxauinotebookgetartprovider
}
94 \constfunc{wxAuiTabArt*
}{GetArtProvider
}{\void}
96 Returns the associated art provider.
98 \membersection{wxAuiNotebook::GetHeightForPageHeight
}\label{wxauinotebookgetheightforpageheight
}
100 \func{int
}{GetHeightForPageHeight
}{\param{int
}{pageHeight
}}
102 Returns the desired height of the notebook for the given page height. Use this to fit the notebook to
105 \membersection{wxAuiNotebook::GetPage
}\label{wxauinotebookgetpage
}
107 \constfunc{wxWindow*
}{GetPage
}{\param{size
\_t }{page
\_idx}}
109 Returns the page specified by the given index.
111 \membersection{wxAuiNotebook::GetPageBitmap
}\label{wxauinotebookgetpagebitmap
}
113 \constfunc{wxBitmap
}{GetPageBitmap
}{\param{size
\_t }{page
}}
115 Returns the tab bitmap for the page.
117 \membersection{wxAuiNotebook::GetPageCount
}\label{wxauinotebookgetpagecount
}
119 \constfunc{size
\_t}{GetPageCount
}{\void}
121 Returns the number of pages in the notebook.
123 \membersection{wxAuiNotebook::GetPageIndex
}\label{wxauinotebookgetpageindex
}
125 \constfunc{int
}{GetPageIndex
}{\param{wxWindow*
}{page
\_wnd}}
127 Returns the page index for the specified window. If the window is not found in
128 the notebook, wxNOT
\_FOUND is returned.
130 \membersection{wxAuiNotebook::GetPageText
}\label{wxauinotebookgetpagetext
}
132 \constfunc{wxString
}{GetPageText
}{\param{size
\_t }{page
}}
134 Returns the tab label for the page.
136 \membersection{wxAuiNotebook::GetTabCtrlHeight
}\label{wxauinotebookgettabctrlheight
}
138 \constfunc{int
}{GetTabCtrlHeight
}{\void}
140 Returns the height of the tab control.
142 \membersection{wxAuiNotebook::GetSelection
}\label{wxauinotebookgetselection
}
144 \constfunc{int
}{GetSelection
}{\void}
146 Returns the currently selected page.
148 \membersection{wxAuiNotebook::GetTabCtrlHeight
}\label{wxauinotebookgettabctrlheight
}
150 \constfunc{int
}{GetTabCtrlHeight
}{\void}
152 Returns the height of the tab control.
154 \membersection{wxAuiNotebook::InsertPage
}\label{wxauinotebookinsertpage
}
156 \func{bool
}{InsertPage
}{\param{size
\_t }{page
\_idx},
\param{wxWindow*
}{page
},
\param{const wxString\&
}{caption
},
\param{bool
}{select = false
},
\param{const wxBitmap\&
}{bitmap = wxNullBitmap
}}
158 InsertPage() is similar to AddPage, but allows the ability to specify the insert location.
159 If the
{\it select
} parameter is true, calling this will generate a page change event.
161 \membersection{wxAuiNotebook::RemovePage
}\label{wxauinotebookremovepage
}
163 \func{bool
}{RemovePage
}{\param{size
\_t }{page
}}
165 Removes a page, without deleting the window pointer.
167 \membersection{wxAuiNotebook::SetArtProvider
}\label{wxauinotebooksetartprovider
}
169 \func{void
}{SetArtProvider
}{\param{wxAuiTabArt*
}{art
}}
171 Sets the art provider to be used by the notebook.
173 \membersection{wxAuiNotebook::SetFont
}\label{wxauinotebooksetfont
}
175 \func{bool
}{SetFont
}{\param{const wxFont\&
}{font
}}
177 Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.
179 \membersection{wxAuiNotebook::SetNormalFont
}\label{wxauinotebooksetnormalfont
}
181 \func{void
}{SetNormalFont
}{\param{const wxFont\&
}{font
}}
183 Sets the font for drawing unselected tab labels.
185 \membersection{wxAuiNotebook::SetSelectedFont
}\label{wxauinotebooksetselectedfont
}
187 \func{void
}{SetSelectedFont
}{\param{const wxFont\&
}{font
}}
189 Sets the font for drawing selected tab labels.
191 \membersection{wxAuiNotebook::SetMeasuringFont
}\label{wxauinotebooksetmeasuringfont
}
193 \func{void
}{SetMeasuringFont
}{\param{const wxFont\&
}{font
}}
195 Sets the font for measuring tab labels.
197 \membersection{wxAuiNotebook::SetPageBitmap
}\label{wxauinotebooksetpagebitmap
}
199 \func{bool
}{SetPageBitmap
}{\param{size
\_t }{page
},
\param{const wxBitmap\&
}{bitmap
}}
201 Sets the bitmap for the page. To remove a bitmap from the tab caption, pass
204 \membersection{wxAuiNotebook::SetPageText
}\label{wxauinotebooksetpagetext
}
206 \func{bool
}{SetPageText
}{\param{size
\_t }{page
},
\param{const wxString\&
}{text
}}
208 Sets the tab label for the page.
210 \membersection{wxAuiNotebook::SetSelection
}\label{wxauinotebooksetselection
}
212 \func{size
\_t}{SetSelection
}{\param{size
\_t }{new
\_page}}
214 Sets the page selection. Calling this method will generate a page change event.
216 \membersection{wxAuiNotebook::SetTabCtrlHeight
}\label{wxauinotebooksettabctrlheight
}
218 \func{void
}{SetTabCtrlHeight
}{\param{int
}{height
}}
220 Sets the tab height. By default, the tab control height is calculated
221 by measuring the text height and bitmap sizes on the tab captions. Calling this
222 method will override that calculation and set the tab control to the specified
223 height parameter. A call to this method will override any call to SetUniformBitmapSize().
224 Specifying -
1 as the height will return the control to its default auto-sizing behaviour.
226 \membersection{wxAuiNotebook::SetUniformBitmapSize
}\label{wxauinotebooksetuniformbitmapsize
}
228 \func{void
}{SetUniformBitmapSize
}{\param{const wxSize\&
}{size
}}
230 SetUniformBitmapSize() ensures that all tabs will have the same height, even
231 if some tabs don't have bitmaps. Passing wxDefaultSize to this function will
232 instruct the control to use dynamic tab height, which is the default behaviour.
233 Under the default behaviour, when a tab with a large bitmap is added, the tab control's
234 height will automatically increase to accommodate the larger bitmap.
236 \func{void
}{Split
}{\param{size
\_t }{page
},
\param{int
}{direction
}}
238 Split performs a split operation programmatically. The argument
\arg{page
} indicates
239 the page that will be split off. This page will also become the active page after the
240 split. The
\arg{direction
} argument specifies where the pane should go, it should be one
241 of the following: wxTOP, wxBOTTOM, wxLEFT, or wxRIGHT.
243 \membersection{wxAuiNotebook::ShowWindowMenu
}\label{wxauinotebookshowwindowmenu
}
245 \func{bool
}{ShowWindowMenu
}{\void}
247 Shows the window menu for the active tab control associated with this notebook,
248 and returns
\true if a selection was made.