AuiNotebook is part of the AUI class framework.
See also AUI overview.
AuiNotebook is a notebook control which implements many features common in applications with dockable panes.
Specifically, AuiNotebook implements functionality which allows the user to rearrange tab order via drag-and-drop,
split the tab window into many different splitter configurations, and toggle through different themes to customize
the control’s look and feel.
An effort has been made to try to maintain an API as similar to that of Notebook.
The default theme that is used is AuiDefaultTabArt, which provides a modern, glossy look and feel.
The theme can be changed by calling AuiNotebook#set_art_provider.
AUI_NB_DEFAULT_STYLE |
Defined as AUI_NB_TOP | AUI_NB_TAB_SPLIT | AUI_NB_TAB_MOVE | AUI_NB_SCROLL_BUTTONS | AUI_NB_CLOSE_ON_ACTIVE_TAB. |
AUI_NB_TAB_SPLIT |
Allows the tab control to be split by dragging a tab. | ||||
AUI_NB_TAB_MOVE |
Allows a tab to be moved horizontally by dragging. | ||||
AUI_NB_TAB_EXTERNAL_MOVE |
Allows a tab to be moved to another tab control. | ||||
AUI_NB_TAB_FIXED_WIDTH |
With this style, all tabs have the same width. | ||||
AUI_NB_SCROLL_BUTTONS |
With this style, left and right scroll buttons are displayed. | ||||
AUI_NB_WINDOWLIST_BUTTON |
With this style, a drop-down list of windows is available. | ||||
AUI_NB_CLOSE_BUTTON |
With this style, a close button is available on the tab bar. | ||||
AUI_NB_CLOSE_ON_ACTIVE_TAB |
With this style, the close button is visible on the active tab. | ||||
AUI_NB_CLOSE_ON_ALL_TABS |
With this style, the close button is visible on all tabs. |
Constructor. Creates a AuiNotebok control.
Adds a page. If the select parameter is true, calling this will generate a page change event.
Creates the notebook window.
Deletes a page at the given index. Calling this method will generate a page change event.
Iterates over all the pages in the notebook, from first to last. Each
page (a Window object) will be passed to the associated block.
Returns the associated art provider.
Returns the page specified by the given index.
Returns the tab bitmap for the page.
Returns the number of pages in the notebook.
Returns the page index for the specified window. If the window is not found in
the notebook, NOT_FOUND is returned.
Returns the tab label for the page.
Returns the currently selected page.
InsertPage() is similar to AddPage, but allows the ability to specify the insert location.
If the select parameter is true, calling this will generate a page change event.
Removes a page, without deleting the window pointer.
Sets the art provider to be used by the notebook.
Sets the bitmap for the page. To remove a bitmap from the tab caption, pass
Wx::NULL_BITMAP
.
Sets the tab label for the page.
Sets the page selection. Calling this method will generate a page change event.
Sets the tab height. By default, the tab control height is calculated
by measuring the text height and bitmap sizes on the tab captions. Calling this
method will override that calculation and set the tab control to the specified
height parameter. A call to this method will override any call to SetUniformBitmapSize().
Specifying -1 as the height will return the control to its default auto-sizing behaviour.
SetUniformBitmapSize() ensures that all tabs will have the same height, even
if some tabs don’t have bitmaps. Passing DefaultSize to this function will
instruct the control to use dynamic tab height, which is the default behaviour.
Under the default behaviour, when a tab with a large bitmap is added, the tab control’s
height will automatically increase to accommodate the larger bitmap.
Split performs a split operation programmatically. The argument page
indicates the page that will be split off. This page will also become
the active page after the split. The direction argument specifies where
the pane should go, it should be one of the following: TOP, BOTTOM,
LEFT, or RIGHT.
Makes the notebook tabs be drawn with a ‘glossy’ style, including a
gradient. This is the default.
Makes the notebook tabs be drawn with a simple, flat style.
[This page automatically generated from the Textile source at 2023-06-09 00:45:31 +0000]