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
43 \twocolitem{\windowstyle{wxAUI
\_NB\_TAB\_SPLIT}}{Allows the tab control to be split by dragging a tab.
}
44 \twocolitem{\windowstyle{wxAUI
\_NB\_TAB\_MOVE}}{Allows a tab to be moved horizontally by dragging.
}
45 \twocolitem{\windowstyle{wxAUI
\_NB\_TAB\_EXTERNAL\_MOVE}}{Allows a tab to be moved to another tab control.
}
46 \twocolitem{\windowstyle{wxAUI
\_NB\_TAB\_FIXED\_WIDTH}}{With this style, all tabs have the same width.
}
47 \twocolitem{\windowstyle{wxAUI
\_NB\_SCROLL\_BUTTONS}}{With this style, left and right scroll buttons are displayed.
}
48 \twocolitem{\windowstyle{wxAUI
\_NB\_WINDOWLIST\_BUTTON}}{With this style, a drop-down list of windows is available.
}
49 \twocolitem{\windowstyle{wxAUI
\_NB\_CLOSE\_BUTTON}}{With this style, a close button is available on the tab bar.
}
50 \twocolitem{\windowstyle{wxAUI
\_NB\_CLOSE\_ON\_ACTIVE\_TAB}}{With this style, the close button is visible on the active tab.
}
51 \twocolitem{\windowstyle{wxAUI
\_NB\_CLOSE\_ON\_ALL\_TABS}}{With this style, the close button is visible on all tabs.
}
55 \wxheading{Data structures
}
57 \latexignore{\rtfignore{\wxheading{Members
}}}
59 \membersection{wxAuiNotebook::wxAuiNotebook
}\label{wxauinotebookwxauinotebook
}
61 \func{}{wxAuiNotebook
}{\void}
63 \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}}
65 Constructor. Creates a wxAuiNotebok control.
67 \membersection{wxAuiNotebook::AddPage
}\label{wxauinotebookaddpage
}
69 \func{bool
}{AddPage
}{\param{wxWindow*
}{page
},
\param{const wxString\&
}{caption
},
\param{bool
}{select = false
},
\param{const wxBitmap\&
}{bitmap = wxNullBitmap
}}
71 Adds a page. If the
{\it select
} parameter is true, calling this will generate a page change event.
73 \membersection{wxAuiNotebook::AdvanceSelection
}\label{wxauinotebookadvanceselection
}
75 \func{void
}{AdvanceSelection
}{\param{bool
}{forward = true
}}
77 Sets the selection to the next or previous page.
79 \membersection{wxAuiNotebook::Create
}\label{wxauinotebookcreate
}
81 \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}}
83 Creates the notebook window.
85 \membersection{wxAuiNotebook::DeletePage
}\label{wxauinotebookdeletepage
}
87 \func{bool
}{DeletePage
}{\param{size
\_t }{page
}}
89 Deletes a page at the given index. Calling this method will generate a page change event.
91 \membersection{wxAuiNotebook::GetArtProvider
}\label{wxauinotebookgetartprovider
}
93 \constfunc{wxAuiTabArt*
}{GetArtProvider
}{\void}
95 Returns the associated art provider.
97 \membersection{wxAuiNotebook::GetHeightForPageHeight
}\label{wxauinotebookgetheightforpageheight
}
99 \func{int
}{GetHeightForPageHeight
}{\param{int
}{pageHeight
}}
101 Returns the desired height of the notebook for the given page height. Use this to fit the notebook to
104 \membersection{wxAuiNotebook::GetPage
}\label{wxauinotebookgetpage
}
106 \constfunc{wxWindow*
}{GetPage
}{\param{size
\_t }{page
\_idx}}
108 Returns the page specified by the given index.
110 \membersection{wxAuiNotebook::GetPageBitmap
}\label{wxauinotebookgetpagebitmap
}
112 \constfunc{wxBitmap
}{GetPageBitmap
}{\param{size
\_t }{page
}}
114 Returns the tab bitmap for the page.
116 \membersection{wxAuiNotebook::GetPageCount
}\label{wxauinotebookgetpagecount
}
118 \constfunc{size
\_t}{GetPageCount
}{\void}
120 Returns the number of pages in the notebook.
122 \membersection{wxAuiNotebook::GetPageIndex
}\label{wxauinotebookgetpageindex
}
124 \constfunc{int
}{GetPageIndex
}{\param{wxWindow*
}{page
\_wnd}}
126 Returns the page index for the specified window. If the window is not found in
127 the notebook, wxNOT
\_FOUND is returned.
129 \membersection{wxAuiNotebook::GetPageText
}\label{wxauinotebookgetpagetext
}
131 \constfunc{wxString
}{GetPageText
}{\param{size
\_t }{page
}}
133 Returns the tab label for the page.
135 \membersection{wxAuiNotebook::GetTabCtrlHeight
}\label{wxauinotebookgettabctrlheight
}
137 \constfunc{int
}{GetTabCtrlHeight
}{\void}
139 Returns the height of the tab control.
141 \membersection{wxAuiNotebook::GetSelection
}\label{wxauinotebookgetselection
}
143 \constfunc{int
}{GetSelection
}{\void}
145 Returns the currently selected page.
147 \membersection{wxAuiNotebook::GetTabCtrlHeight
}\label{wxauinotebookgettabctrlheight
}
149 \constfunc{int
}{GetTabCtrlHeight
}{\void}
151 Returns the height of the tab control.
153 \membersection{wxAuiNotebook::InsertPage
}\label{wxauinotebookinsertpage
}
155 \func{bool
}{InsertPage
}{\param{size
\_t }{page
\_idx},
\param{wxWindow*
}{page
},
\param{const wxString\&
}{caption
},
\param{bool
}{select = false
},
\param{const wxBitmap\&
}{bitmap = wxNullBitmap
}}
157 InsertPage() is similar to AddPage, but allows the ability to specify the insert location.
158 If the
{\it select
} parameter is true, calling this will generate a page change event.
160 \membersection{wxAuiNotebook::RemovePage
}\label{wxauinotebookremovepage
}
162 \func{bool
}{RemovePage
}{\param{size
\_t }{page
}}
164 Removes a page, without deleting the window pointer.
166 \membersection{wxAuiNotebook::SetArtProvider
}\label{wxauinotebooksetartprovider
}
168 \func{void
}{SetArtProvider
}{\param{wxAuiTabArt*
}{art
}}
170 Sets the art provider to be used by the notebook.
172 \membersection{wxAuiNotebook::SetFont
}\label{wxauinotebooksetfont
}
174 \func{bool
}{SetFont
}{\param{const wxFont\&
}{font
}}
176 Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.
178 \membersection{wxAuiNotebook::SetNormalFont
}\label{wxauinotebooksetnormalfont
}
180 \func{void
}{SetNormalFont
}{\param{const wxFont\&
}{font
}}
182 Sets the font for drawing unselected tab labels.
184 \membersection{wxAuiNotebook::SetSelectedFont
}\label{wxauinotebooksetselectedfont
}
186 \func{void
}{SetSelectedFont
}{\param{const wxFont\&
}{font
}}
188 Sets the font for drawing selected tab labels.
190 \membersection{wxAuiNotebook::SetMeasuringFont
}\label{wxauinotebooksetmeasuringfont
}
192 \func{void
}{SetMeasuringFont
}{\param{const wxFont\&
}{font
}}
194 Sets the font for measuring tab labels.
196 \membersection{wxAuiNotebook::SetPageBitmap
}\label{wxauinotebooksetpagebitmap
}
198 \func{bool
}{SetPageBitmap
}{\param{size
\_t }{page
},
\param{const wxBitmap\&
}{bitmap
}}
200 Sets the bitmap for the page. To remove a bitmap from the tab caption, pass
203 \membersection{wxAuiNotebook::SetPageText
}\label{wxauinotebooksetpagetext
}
205 \func{bool
}{SetPageText
}{\param{size
\_t }{page
},
\param{const wxString\&
}{text
}}
207 Sets the tab label for the page.
209 \membersection{wxAuiNotebook::SetSelection
}\label{wxauinotebooksetselection
}
211 \func{size
\_t}{SetSelection
}{\param{size
\_t }{new
\_page}}
213 Sets the page selection. Calling this method will generate a page change event.
215 \membersection{wxAuiNotebook::SetTabCtrlHeight
}\label{wxauinotebooksettabctrlheight
}
217 \func{void
}{SetTabCtrlHeight
}{\param{int
}{height
}}
219 Sets the tab height. By default, the tab control height is calculated
220 by measuring the text height and bitmap sizes on the tab captions. Calling this
221 method will override that calculation and set the tab control to the specified
222 height parameter. A call to this method will override any call to SetUniformBitmapSize().
223 Specifying -
1 as the height will return the control to its default auto-sizing behaviour.
225 \membersection{wxAuiNotebook::SetUniformBitmapSize
}\label{wxauinotebooksetuniformbitmapsize
}
227 \func{void
}{SetUniformBitmapSize
}{\param{const wxSize\&
}{size
}}
229 SetUniformBitmapSize() ensures that all tabs will have the same height, even
230 if some tabs don't have bitmaps. Passing wxDefaultSize to this function will
231 instruct the control to use dynamic tab height, which is the default behaviour.
232 Under the default behaviour, when a tab with a large bitmap is added, the tab control's
233 height will automatically increase to accommodate the larger bitmap.
235 \func{void
}{Split
}{\param{size
\_t }{page
},
\param{int
}{direction
}}
237 Split performs a split operation programmatically. The argument
\arg{page
} indicates
238 the page that will be split off. This page will also become the active page after the
239 split. The
\arg{direction
} argument specifies where the pane should go, it should be one
240 of the following: wxTOP, wxBOTTOM, wxLEFT, or wxRIGHT.
242 \membersection{wxAuiNotebook::ShowWindowMenu
}\label{wxauinotebookshowwindowmenu
}
244 \func{bool
}{ShowWindowMenu
}{\void}
246 Shows the window menu for the active tab control associated with this notebook,
247 and returns
\true if a selection was made.