wxAuiNotebookPage Class Reference

#include <wx/aui/auibook.h>

Detailed Description

Holds information about a page in wxAuiNotebook.

An object of this class is notably passed to wxAuiTabArt::DrawTab() and is used by it to render the pages tab accordingly.

Library:  wxAui

Category:  Window Docking (wxAUI)

Public Attributes
wxWindow *	window = nullptr
	Window shown on this page. More...
wxString	caption
	Text displayed on the tab. More...
wxString	tooltip
	Tooltip displayed when hovering over tab title. More...
wxBitmapBundle	bitmap
	Bitmap shown in the tab if valid. More...
wxRect	rect
	The bounding rectangle of this page tab. More...
bool	active = false
	True if the page is the currently selected page. More...
std::vector< wxAuiTabContainerButton >	buttons
	Vector with per-page buttons. More...

Member Data Documentation

active

bool wxAuiNotebookPage::active = false

True if the page is the currently selected page.

bitmap

wxBitmapBundle wxAuiNotebookPage::bitmap

Bitmap shown in the tab if valid.

buttons

std::vector<wxAuiTabContainerButton> wxAuiNotebookPage::buttons

Vector with per-page buttons.

This vector may be empty.

Since

3.3.0

caption

wxString wxAuiNotebookPage::caption

Text displayed on the tab.

rect

wxRect wxAuiNotebookPage::rect

The bounding rectangle of this page tab.

tooltip

wxString wxAuiNotebookPage::tooltip

Tooltip displayed when hovering over tab title.

window

wxWindow* wxAuiNotebookPage::window = nullptr

Window shown on this page.