Contents Up Previous Next

wxAuiNotebook

wxAuiPaneInfo is part of the wxAUI class framework. See also wxAUI overview.

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.

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

The default theme that is used is wxAuiDefaultTabArt, which provides a modern, glossy look and feel. The theme can be changed by calling wxAuiNotebook::SetArtProvider.

Derived from

wxControl

Include files

<wx/aui/auibook.h>

Data structures

Members

wxAuiNotebook::wxAuiNotebook
wxAuiNotebook::AddPage
wxAuiNotebook::Create
wxAuiNotebook::DeletePage
wxAuiNotebook::GetArtProvider
wxAuiNotebook::GetPage
wxAuiNotebook::GetPageCount
wxAuiNotebook::GetPageIndex
wxAuiNotebook::GetSelection
wxAuiNotebook::InsertPage
wxAuiNotebook::RemovePage
wxAuiNotebook::SetArtProvider
wxAuiNotebook::SetPageBitmap
wxAuiNotebook::SetPageText
wxAuiNotebook::SetSelection
wxAuiNotebook::SetTabCtrlHeight


wxAuiNotebook::wxAuiNotebook

wxAuiNotebook()

wxAuiNotebook(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxAUI_NB_DEFAULT_STYLE)

Constructor. Creates a wxAuiNotebok control.


wxAuiNotebook::AddPage

bool AddPage(wxWindow* page, const wxString& caption, bool select = false, const wxBitmap& bitmap = wxNullBitmap)

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


wxAuiNotebook::Create

bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0)

Creates the notebook window.


wxAuiNotebook::DeletePage

bool DeletePage(size_t page)

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


wxAuiNotebook::GetArtProvider

wxAuiTabArt* GetArtProvider() const

Returns the associated art provider.


wxAuiNotebook::GetPage

wxWindow* GetPage(size_t page_idx) const

Returns the page specified by the given index.


wxAuiNotebook::GetPageCount

size_t GetPageCount() const

Returns the number of pages.


wxAuiNotebook::GetPageIndex

int GetPageIndex(wxWindow* page_wnd) const

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


wxAuiNotebook::GetSelection

int GetSelection() const

Returns the currently selected page.


wxAuiNotebook::InsertPage

bool InsertPage(size_t page_idx, wxWindow* page, const wxString& caption, bool select = false, const wxBitmap& bitmap = wxNullBitmap)

Inserts a page.


wxAuiNotebook::RemovePage

bool RemovePage(size_t page)

Removes a page, without deleting the window pointer.


wxAuiNotebook::SetArtProvider

void SetArtProvider(wxAuiTabArt* art)

Sets the art provider to be used by the notebook.


wxAuiNotebook::SetPageBitmap

bool SetPageBitmap(size_t page, const wxBitmap& bitmap)

Sets the bitmap for the page.


wxAuiNotebook::SetPageText

bool SetPageText(size_t page, const wxString& text)

Sets the tab label for the page.


wxAuiNotebook::SetSelection

size_t SetSelection(size_t new_page)

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


wxAuiNotebook::SetTabCtrlHeight

void SetTabCtrlHeight(int height)

Sets the tab height.