Contents Up Previous Next

wxAuiNotebook

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 spliiter 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

<auibook.h>

Data structures

Members

wxAuiNotebook::wxAuiNotebook
wxAuiNotebook::~wxAuiNotebook
wxAuiNotebook::AddPage
wxAuiNotebook::Create
wxAuiNotebook::DeletePage
wxAuiNotebook::DoSizing
wxAuiNotebook::FindTab
wxAuiNotebook::GetActiveTabCtrl
wxAuiNotebook::GetArtProvider
wxAuiNotebook::GetPage
wxAuiNotebook::GetPageCount
wxAuiNotebook::GetPageIndex
wxAuiNotebook::GetSelection
wxAuiNotebook::InitNotebook
wxAuiNotebook::InsertPage
wxAuiNotebook::RemovePage
wxAuiNotebook::SetArtProvider
wxAuiNotebook::SetPageBitmap
wxAuiNotebook::SetPageText
wxAuiNotebook::SetSelection
wxAuiNotebook::SetTabCtrlHeight
wxAuiNotebook::SetWindowStyleFlag


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::~wxAuiNotebook

~wxAuiNotebook()


wxAuiNotebook::AddPage

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


wxAuiNotebook::Create

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


wxAuiNotebook::DeletePage

bool DeletePage(size_t page)


wxAuiNotebook::DoSizing

void DoSizing()


wxAuiNotebook::FindTab

bool FindTab(wxWindow* page, wxAuiTabCtrl** ctrl, int* idx)


wxAuiNotebook::GetActiveTabCtrl

wxAuiTabCtrl* GetActiveTabCtrl()


wxAuiNotebook::GetArtProvider

wxAuiTabArt* GetArtProvider() const


wxAuiNotebook::GetPage

wxWindow* GetPage(size_t page_idx) const


wxAuiNotebook::GetPageCount

size_t GetPageCount() const


wxAuiNotebook::GetPageIndex

int GetPageIndex(wxWindow* page_wnd) const


wxAuiNotebook::GetSelection

int GetSelection() const


wxAuiNotebook::InitNotebook

void InitNotebook(long style)


wxAuiNotebook::InsertPage

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


wxAuiNotebook::RemovePage

bool RemovePage(size_t page)


wxAuiNotebook::SetArtProvider

void SetArtProvider(wxAuiTabArt* art)


wxAuiNotebook::SetPageBitmap

bool SetPageBitmap(size_t page, const wxBitmap& bitmap)


wxAuiNotebook::SetPageText

bool SetPageText(size_t page, const wxString& text)


wxAuiNotebook::SetSelection

size_t SetSelection(size_t new_page)


wxAuiNotebook::SetTabCtrlHeight

void SetTabCtrlHeight(int height)

these can be overridden


wxAuiNotebook::SetWindowStyleFlag

void SetWindowStyleFlag(long style)