wxAuiSimpleTabArt Class Reference

#include <wx/aui/auibook.h>

Inheritance diagram for wxAuiSimpleTabArt:

Detailed Description

Another standard tab art provider for wxAuiNotebook.

wxAuiSimpleTabArt is derived from wxAuiTabArt demonstrating how to write a completely new tab art class. It can also be used as alternative to wxAuiDefaultTabArt.

Appearance:

Generic Appearance

Library:  wxAui

Category:  Window Docking (wxAUI)

Public Member Functions
	wxAuiSimpleTabArt ()
virtual	~wxAuiSimpleTabArt ()
wxAuiTabArt *	Clone ()
	Clones the art object.
void	SetFlags (unsigned int flags)
	Sets flags.
void	SetSizingInfo (const wxSize &tabCtrlSize, size_t tabCount, wxWindow *wnd=nullptr)
	Sets sizing information.
void	SetNormalFont (const wxFont &font)
	Sets the normal font for drawing labels.
void	SetSelectedFont (const wxFont &font)
	Sets the font for drawing text for selected UI elements.
void	SetMeasuringFont (const wxFont &font)
	Sets the font used for calculating measurements.
void	SetColour (const wxColour &colour)
	Sets the colour of the inactive tabs.
void	SetActiveColour (const wxColour &colour)
	Sets the colour of the selected tab.
void	DrawBackground (wxDC &dc, wxWindow *wnd, const wxRect &rect)
	Draws a background on the given area.
void	DrawTab (wxDC &dc, wxWindow *wnd, const wxAuiNotebookPage &pane, const wxRect &inRect, int closeButtonState, wxRect *outTabRect, wxRect *outButtonRect, int *xExtent)
	Draws a tab.
void	DrawButton (wxDC &dc, wxWindow *wnd, const wxRect &inRect, int bitmapId, int buttonState, int orientation, wxRect *outRect)
	Draws a button.
int	GetIndentSize ()
	Returns the indent size.
wxSize	GetTabSize (wxReadOnlyDC &dc, wxWindow *wnd, const wxString &caption, const wxBitmap &bitmap, bool active, int closeButtonState, int *xExtent)
int	ShowDropDown (wxWindow *wnd, const wxAuiNotebookPageArray &items, int activeIdx)
int	GetBestTabCtrlSize (wxWindow *wnd, const wxAuiNotebookPageArray &pages, const wxSize &requiredBmpSize)
	Returns the tab control size.
Public Member Functions inherited from wxAuiTabArt
	wxAuiTabArt ()
	Constructor.
virtual int	DrawPageTab (wxDC &dc, wxWindow *wnd, wxAuiNotebookPage &page, const wxRect &rect)
	Draws a tab for the specified notebook page.
virtual wxFont	GetNormalFont () const
	Returns the font to use for normal, non-selected, tabs.
virtual wxFont	GetSelectedFont () const
	Returns the font to use for the selected tab.
virtual wxSize	GetTabSize (wxReadOnlyDC &dc, wxWindow *wnd, const wxString &caption, const wxBitmapBundle &bitmap, bool active, int close_button_state, int *x_extent)
	Returns the tab size for the given caption, bitmap and state.
virtual wxSize	GetPageTabSize (wxReadOnlyDC &dc, wxWindow *wnd, const wxAuiNotebookPage &page, int *xExtent=nullptr)
	Returns the size of the tab for the specified notebook page.
virtual int	GetButtonRect (wxReadOnlyDC &dc, wxWindow *wnd, const wxRect &inRect, int bitmapId, int buttonState, int orientation, wxRect *outRect=nullptr)
	Returns the rectangle for the given button.

Protected Attributes
wxFont	m_normalFont
wxFont	m_selectedFont
wxFont	m_measuringFont
wxPen	m_normalBkPen
wxPen	m_selectedBkPen
wxBrush	m_normalBkBrush
wxBrush	m_selectedBkBrush
wxBrush	m_bkBrush
wxBitmapBundle	m_activeCloseBmp
wxBitmapBundle	m_disabledCloseBmp
wxBitmapBundle	m_activeLeftBmp
wxBitmapBundle	m_disabledLeftBmp
wxBitmapBundle	m_activeRightBmp
wxBitmapBundle	m_disabledRightBmp
wxBitmapBundle	m_activeWindowListBmp
wxBitmapBundle	m_disabledWindowListBmp
int	m_fixedTabWidth
unsigned int	m_flags

Constructor & Destructor Documentation

wxAuiSimpleTabArt()

wxAuiSimpleTabArt::wxAuiSimpleTabArt

(

)

~wxAuiSimpleTabArt()

virtual wxAuiSimpleTabArt::~wxAuiSimpleTabArt ( )

virtual

Member Function Documentation

Clone()

wxAuiTabArt * wxAuiSimpleTabArt::Clone ( )

virtual

Clones the art object.

Implements wxAuiTabArt.

DrawBackground()

void wxAuiSimpleTabArt::DrawBackground ( wxDC & dc, wxWindow * wnd, const wxRect & rect )

virtual

Draws a background on the given area.

Implements wxAuiTabArt.

DrawButton()

void wxAuiSimpleTabArt::DrawButton ( wxDC & dc, wxWindow * wnd, const wxRect & in_rect, int bitmap_id, int button_state, int orientation, wxRect * out_rect )

virtual

Draws a button.

Implements wxAuiTabArt.

DrawTab()

void wxAuiSimpleTabArt::DrawTab ( wxDC & dc, wxWindow * wnd, const wxAuiNotebookPage & page, const wxRect & rect, int close_button_state, wxRect * out_tab_rect, wxRect * out_button_rect, int * x_extent )

virtual

Draws a tab.

This function used to be pure virtual and so had to be overridden in the derived classes in the previous versions of wxWidgets, however since version 3.3.0 it doesn't have to be overridden if DrawPageTab() is overridden and, moreover, it is recommended to override DrawPageTab() instead of this function in the new code.

Reimplemented from wxAuiTabArt.

GetBestTabCtrlSize()

int wxAuiSimpleTabArt::GetBestTabCtrlSize ( wxWindow * , const wxAuiNotebookPageArray & , const wxSize &  )

virtual

Returns the tab control size.

Implements wxAuiTabArt.

GetIndentSize()

int wxAuiSimpleTabArt::GetIndentSize ( )

virtual

Returns the indent size.

Implements wxAuiTabArt.

GetTabSize()

wxSize wxAuiSimpleTabArt::GetTabSize	(	wxReadOnlyDC &	dc,
		wxWindow *	wnd,
		const wxString &	caption,
		const wxBitmap &	bitmap,
		bool	active,
		int	closeButtonState,
		int *	xExtent )

SetActiveColour()

void wxAuiSimpleTabArt::SetActiveColour ( const wxColour & colour )

virtual

Sets the colour of the selected tab.

Since

2.9.2

Implements wxAuiTabArt.

SetColour()

void wxAuiSimpleTabArt::SetColour ( const wxColour & colour )

virtual

Sets the colour of the inactive tabs.

Since

2.9.2

Implements wxAuiTabArt.

SetFlags()

void wxAuiSimpleTabArt::SetFlags ( unsigned int flags )

virtual

Sets flags.

Implements wxAuiTabArt.

SetMeasuringFont()

void wxAuiSimpleTabArt::SetMeasuringFont ( const wxFont & font )

virtual

Sets the font used for calculating measurements.

Implements wxAuiTabArt.

SetNormalFont()

void wxAuiSimpleTabArt::SetNormalFont ( const wxFont & font )

virtual

Sets the normal font for drawing labels.

See also

GetNormalFont()

Implements wxAuiTabArt.

SetSelectedFont()

void wxAuiSimpleTabArt::SetSelectedFont ( const wxFont & font )

virtual

Sets the font for drawing text for selected UI elements.

See also

GetSelectedFont()

Implements wxAuiTabArt.

SetSizingInfo()

void wxAuiSimpleTabArt::SetSizingInfo ( const wxSize & tab_ctrl_size, size_t tab_count, wxWindow * wnd = nullptr )

virtual

Sets sizing information.

The wnd argument is only present in wxWidgets 3.1.6 and newer and is required, it only has nullptr default value for compatibility reasons.

Implements wxAuiTabArt.

ShowDropDown()

int wxAuiSimpleTabArt::ShowDropDown	(	wxWindow *	wnd,
		const wxAuiNotebookPageArray &	items,
		int	activeIdx )

Member Data Documentation

m_activeCloseBmp

wxBitmapBundle wxAuiSimpleTabArt::m_activeCloseBmp

protected

m_activeLeftBmp

wxBitmapBundle wxAuiSimpleTabArt::m_activeLeftBmp

protected

m_activeRightBmp

wxBitmapBundle wxAuiSimpleTabArt::m_activeRightBmp

protected

m_activeWindowListBmp

wxBitmapBundle wxAuiSimpleTabArt::m_activeWindowListBmp

protected

m_bkBrush

wxBrush wxAuiSimpleTabArt::m_bkBrush

protected

m_disabledCloseBmp

wxBitmapBundle wxAuiSimpleTabArt::m_disabledCloseBmp

protected

m_disabledLeftBmp

wxBitmapBundle wxAuiSimpleTabArt::m_disabledLeftBmp

protected

m_disabledRightBmp

wxBitmapBundle wxAuiSimpleTabArt::m_disabledRightBmp

protected

m_disabledWindowListBmp

wxBitmapBundle wxAuiSimpleTabArt::m_disabledWindowListBmp

protected

m_fixedTabWidth

int wxAuiSimpleTabArt::m_fixedTabWidth

protected

m_flags

unsigned int wxAuiSimpleTabArt::m_flags

protected

m_measuringFont

wxFont wxAuiSimpleTabArt::m_measuringFont

protected

m_normalBkBrush

wxBrush wxAuiSimpleTabArt::m_normalBkBrush

protected

m_normalBkPen

wxPen wxAuiSimpleTabArt::m_normalBkPen

protected

m_normalFont

wxFont wxAuiSimpleTabArt::m_normalFont

protected

m_selectedBkBrush

wxBrush wxAuiSimpleTabArt::m_selectedBkBrush

protected

m_selectedBkPen

wxPen wxAuiSimpleTabArt::m_selectedBkPen

protected

m_selectedFont

wxFont wxAuiSimpleTabArt::m_selectedFont

protected