View Source wxAuiNotebook (wx v2.4.2)
Functions for wxAuiNotebook class
wxAuiNotebook is part of the wxAUI class framework, which represents a
notebook control, managing multiple windows with associated tabs.
See also overview_aui.
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.
The default theme that is used is wxAuiDefaultTabArt (not implemented in wx),
which provides a modern, glossy look and feel. The theme can be changed by
calling setArtProvider/2.
Styles
This class supports the following styles:
This class is derived (and can use functions) from: wxControl wxWindow
wxEvtHandler
wxWidgets docs: wxAuiNotebook
Events
Event types emitted from this class:
command_auinotebook_page_close,
command_auinotebook_page_closed,
command_auinotebook_page_changed,
command_auinotebook_page_changing,
command_auinotebook_button,
command_auinotebook_begin_drag,
command_auinotebook_end_drag,
command_auinotebook_drag_motion,
command_auinotebook_allow_dnd,
command_auinotebook_drag_done,
command_auinotebook_tab_middle_down,
command_auinotebook_tab_middle_up,
command_auinotebook_tab_right_down,
command_auinotebook_tab_right_up,
command_auinotebook_bg_dclick
Summary
Functions
Adds a page.
Adds a new page.
Creates the notebook window.
Constructs the book control with the given parameters.
Deletes a page at the given index.
Destroys the object.
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.
Returns the tab label for the page.
Returns the currently selected page.
insertPage/6 is similar to AddPage, but allows the ability to specify the
insert location.
Inserts a new page at the specified position.
Default ctor.
Constructor.
Removes a page, without deleting the window pointer.
Sets the art provider to be used by the notebook.
Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.
Sets the bitmap for the page.
Sets the tab label for the page.
Sets the page selection.
Sets the tab height.
Ensure that all tabs have the same height, even if some of them don't have bitmaps.
Types
-type wxAuiNotebook() :: wx:wx_object().
Functions
-spec addPage(This, Page, Caption) -> boolean() when This :: wxAuiNotebook(), Page :: wxWindow:wxWindow(), Caption :: unicode:chardata().
-spec addPage(This, Page, Caption, [Option]) -> boolean() when This :: wxAuiNotebook(), Page :: wxWindow:wxWindow(), Caption :: unicode:chardata(), Option :: {select, boolean()} | {bitmap, wxBitmap:wxBitmap()}.
Adds a page.
If the select parameter is true, calling this will generate a page change
event.
-spec addPage(This, Page, Text, Select, ImageId) -> boolean() when This :: wxAuiNotebook(), Page :: wxWindow:wxWindow(), Text :: unicode:chardata(), Select :: boolean(), ImageId :: integer().
Adds a new page.
The page must have the book control itself as the parent and must not have been added to this control previously.
The call to this function may generate the page changing events.
Return: true if successful, false otherwise.
Remark: Do not delete the page, it will be deleted by the book control.
See: insertPage/6
Since: 2.9.3
-spec create(This, Parent) -> boolean() when This :: wxAuiNotebook(), Parent :: wxWindow:wxWindow().
-spec create(This, Parent, Winid) -> boolean() when This :: wxAuiNotebook(), Parent :: wxWindow:wxWindow(), Winid :: integer(); (This, Parent, [Option]) -> boolean() when This :: wxAuiNotebook(), Parent :: wxWindow:wxWindow(), Option :: {id, integer()} | {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()}.
Creates the notebook window.
-spec create(This, Parent, Winid, [Option]) -> boolean() when This :: wxAuiNotebook(), Parent :: wxWindow:wxWindow(), Winid :: integer(), Option :: {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()}.
Constructs the book control with the given parameters.
-spec deletePage(This, Page) -> boolean() when This :: wxAuiNotebook(), Page :: integer().
Deletes a page at the given index.
Calling this method will generate a page change event.
-spec destroy(This :: wxAuiNotebook()) -> ok.
Destroys the object.
-spec getArtProvider(This) -> wxAuiTabArt:wxAuiTabArt() when This :: wxAuiNotebook().
Returns the associated art provider.
-spec getPage(This, Page_idx) -> wxWindow:wxWindow() when This :: wxAuiNotebook(), Page_idx :: integer().
Returns the page specified by the given index.
-spec getPageBitmap(This, Page) -> wxBitmap:wxBitmap() when This :: wxAuiNotebook(), Page :: integer().
Returns the tab bitmap for the page.
-spec getPageCount(This) -> integer() when This :: wxAuiNotebook().
Returns the number of pages in the notebook.
-spec getPageIndex(This, Page_wnd) -> integer() when This :: wxAuiNotebook(), Page_wnd :: wxWindow:wxWindow().
Returns the page index for the specified window.
If the window is not found in the notebook, wxNOT_FOUND is returned.
-spec getPageText(This, Page) -> unicode:charlist() when This :: wxAuiNotebook(), Page :: integer().
Returns the tab label for the page.
-spec getSelection(This) -> integer() when This :: wxAuiNotebook().
Returns the currently selected page.
-spec insertPage(This, Page_idx, Page, Caption) -> boolean() when This :: wxAuiNotebook(), Page_idx :: integer(), Page :: wxWindow:wxWindow(), Caption :: unicode:chardata().
-spec insertPage(This, Page_idx, Page, Caption, [Option]) -> boolean() when This :: wxAuiNotebook(), Page_idx :: integer(), Page :: wxWindow:wxWindow(), Caption :: unicode:chardata(), Option :: {select, boolean()} | {bitmap, wxBitmap:wxBitmap()}.
insertPage/6 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.
-spec insertPage(This, Index, Page, Text, Select, ImageId) -> boolean() when This :: wxAuiNotebook(), Index :: integer(), Page :: wxWindow:wxWindow(), Text :: unicode:chardata(), Select :: boolean(), ImageId :: integer().
Inserts a new page at the specified position.
Return: true if successful, false otherwise.
Remark: Do not delete the page, it will be deleted by the book control.
See: addPage/5
Since: 2.9.3
-spec new() -> wxAuiNotebook().
Default ctor.
-spec new(Parent) -> wxAuiNotebook() when Parent :: wxWindow:wxWindow().
-spec new(Parent, [Option]) -> wxAuiNotebook() when Parent :: wxWindow:wxWindow(), Option :: {id, integer()} | {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()}.
Constructor.
Creates a wxAuiNotebok control.
-spec removePage(This, Page) -> boolean() when This :: wxAuiNotebook(), Page :: integer().
Removes a page, without deleting the window pointer.
-spec setArtProvider(This, Art) -> ok when This :: wxAuiNotebook(), Art :: wxAuiTabArt:wxAuiTabArt().
Sets the art provider to be used by the notebook.
-spec setFont(This, Font) -> boolean() when This :: wxAuiNotebook(), Font :: wxFont:wxFont().
Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.
-spec setPageBitmap(This, Page, Bitmap) -> boolean() when This :: wxAuiNotebook(), Page :: integer(), Bitmap :: wxBitmap:wxBitmap().
Sets the bitmap for the page.
To remove a bitmap from the tab caption, pass wxNullBitmap.
-spec setPageText(This, Page, Text) -> boolean() when This :: wxAuiNotebook(), Page :: integer(), Text :: unicode:chardata().
Sets the tab label for the page.
-spec setSelection(This, New_page) -> integer() when This :: wxAuiNotebook(), New_page :: integer().
Sets the page selection.
Calling this method will generate a page change event.
-spec setTabCtrlHeight(This, Height) -> ok when This :: wxAuiNotebook(), Height :: integer().
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/2.
Specifying -1 as the height will return the control to its default auto-sizing behaviour.
-spec setUniformBitmapSize(This, Size) -> ok when This :: wxAuiNotebook(), Size :: {W :: integer(), H :: integer()}.
Ensure that all tabs have the same height, even if some of them don't have bitmaps.
Passing ?wxDefaultSize as size undoes the effect of a previous call to this
function and instructs the control to use dynamic tab height.