wxAuiNotebook

wxAuiNotebook
wxAuiNotebook is part of the wxAUI class framework. See also the Advanced User Interface overview.

Creation Parameters

wxAuiNotebook is a notebook control which implements many features common in applications with dockable panes. Specifically, wxAuiNotebook 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 (not fully implemented in wxEuphoria v0.12)

An effort has been made to try to maintain an API as similar to that of wxNotebook.

Functions/Procedures
Supertopics

wxAuiNotebook

[func]
aui_get_selection
( atom nb )

Category: wxAuiNotebook

Returns the currently selected page.


wxAuiNotebook

[func]
aui_notebook_add_page
( atom nb, atom page, sequence caption, atom select, atom bitmap )

Category: wxAuiNotebook

Adds a page. If the select parameter is true, calling this will generate a page change event.


wxAuiNotebook

[func]
aui_notebook_delete_page
( atom nb, atom page )

Category: wxAuiNotebook

Deletes a page at the given index. Calling this method will generate a page change event.


wxAuiNotebook

[func]
aui_notebook_get_art_provider
( atom nb )

Category: wxAuiNotebook

Returns the associated art provider.


wxAuiNotebook

[func]
aui_notebook_get_page
( atom nb, atom page_idx )

Category: wxAuiNotebook

Returns the page specified by the given index.


wxAuiNotebook

[func]
aui_notebook_get_page_bitmap
( atom nb, atom page )

Category: wxAuiNotebook

Returns the tab bitmap for the page.


wxAuiNotebook

[func]
aui_notebook_get_page_count
( atom nb )

Category: wxAuiNotebook

Returns the number of pages in the notebook.


wxAuiNotebook

[func]
aui_notebook_get_page_index
( atom nb, atom page_wnd )

Category: wxAuiNotebook

Returns the page index for the specified window. If the window is not found in the notebook, wxNOT_FOUND is returned.


wxAuiNotebook

[func]
aui_notebook_insert_page
( atom nb, atom page_idx, atom page, sequence caption, atom select, atom bitmap )

Category: wxAuiNotebook

Similar to aui_notebook_add_page, but allows the ability to specify the insert location. If the select parameter is true, calling this will generate a page change event.


wxAuiNotebook

[func]
aui_notebook_remove_page
( atom nb, atom page )

Category: wxAuiNotebook

Removes a page, without deleting the window pointer.


wxAuiNotebook

[proc]
aui_notebook_set_art_provider
( atom nb, atom art )

Category: wxAuiNotebook

Sets the art provider to be used by the notebook.


wxAuiNotebook

[func]
aui_notebook_set_page_bitmap
( atom nb, atom page, atom bitmap )

Category: wxAuiNotebook

Sets the bitmap for the page. To remove a bitmap from the tab caption, pass wxNullBitmap.


wxAuiNotebook

[func]
aui_notebook_set_page_text
( atom nb, atom page, sequence text )

Category: wxAuiNotebook

Sets the tab label for the page.


wxAuiNotebook

[func]
aui_notebook_set_selection
( atom nb, atom new_page )

Category: wxAuiNotebook

Sets the page selection. Calling this method will generate a page change event.


wxAuiNotebook

[proc]
aui_notebook_set_tab_ctrl_height
( atom nb, atom height )

Category: wxAuiNotebook

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 aui_notebook_set_uniform_bitmap_size. Specifying -1 as the height will return the control to its default auto-sizing behaviour.


wxAuiNotebook

[proc]
aui_notebook_set_uniform_bitmap_size
( atom nb, atom x, atom y )

Category: wxAuiNotebook

Ensures that all tabs will have the same height, even if some tabs don't have bitmaps. Passing wxDefaultSize 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.


wxAuiNotebook

[proc]
aui_notebook_split
( atom nb, atom page, atom direction )

Category: wxAuiNotebook

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: wxTOP, wxBOTTOM, wxLEFT, or wxRIGHT.