wxAuiDefaultTabArt Class Reference

#include <wx/aui/auibook.h>

Inheritance diagram for wxAuiDefaultTabArt:

Detailed Description

Default art provider for wxAuiNotebook.

See also

wxAuiTabArt

Appearance:

Generic Appearance

Library:  wxAui

Category:  Window Docking (wxAUI)

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

Protected Attributes
wxFont	m_normalFont
	The font used for all tabs. More...
wxFont	m_selectedFont
wxFont	m_measuringFont
	The font used on the selected tab. More...
wxColour	m_baseColour
wxPen	m_baseColourPen
wxPen	m_borderPen
wxBrush	m_baseColourBrush
wxColour	m_activeColour
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
int	m_tabCtrlHeight
unsigned int	m_flags

Constructor & Destructor Documentation

wxAuiDefaultTabArt()

wxAuiDefaultTabArt::wxAuiDefaultTabArt

(

)

~wxAuiDefaultTabArt()

virtual wxAuiDefaultTabArt::~wxAuiDefaultTabArt ( )

virtual

Member Function Documentation

Clone()

wxAuiTabArt* wxAuiDefaultTabArt::Clone ( )

virtual

Clones the art object.

Implements wxAuiTabArt.

DrawBackground()

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

virtual

Draws a background on the given area.

Implements wxAuiTabArt.

DrawButton()

void wxAuiDefaultTabArt::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 wxAuiDefaultTabArt::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.

Implements wxAuiTabArt.

GetBestTabCtrlSize()

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

virtual

Returns the tab control size.

Implements wxAuiTabArt.

GetIndentSize()

int wxAuiDefaultTabArt::GetIndentSize ( )

virtual

Returns the indent size.

Implements wxAuiTabArt.

GetTabSize()

wxSize wxAuiDefaultTabArt::GetTabSize ( wxDC &  dc, wxWindow *  wnd, const wxString &  caption, const wxBitmapBundle &  bitmap, bool  active, int  close_button_state, int *  x_extent  )

virtual

Returns the tab size for the given caption, bitmap and state.

Implements wxAuiTabArt.

SetActiveColour()

void wxAuiDefaultTabArt::SetActiveColour ( const wxColour &  colour )

virtual

Sets the colour of the selected tab.

Since

2.9.2

Implements wxAuiTabArt.

SetColour()

void wxAuiDefaultTabArt::SetColour ( const wxColour &  colour )

virtual

Sets the colour of the inactive tabs.

Since

2.9.2

Implements wxAuiTabArt.

SetFlags()

void wxAuiDefaultTabArt::SetFlags ( unsigned int  flags )

virtual

Sets flags.

Implements wxAuiTabArt.

SetMeasuringFont()

void wxAuiDefaultTabArt::SetMeasuringFont ( const wxFont &  font )

virtual

Sets the font used for calculating measurements.

Implements wxAuiTabArt.

SetNormalFont()

void wxAuiDefaultTabArt::SetNormalFont ( const wxFont &  font )

virtual

Sets the normal font for drawing labels.

Implements wxAuiTabArt.

SetSelectedFont()

void wxAuiDefaultTabArt::SetSelectedFont ( const wxFont &  font )

virtual

Sets the font for drawing text for selected UI elements.

Implements wxAuiTabArt.

SetSizingInfo()

void wxAuiDefaultTabArt::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 wxAuiDefaultTabArt::ShowDropDown	(	wxWindow *	wnd,
		const wxAuiNotebookPageArray &	items,
		int	activeIdx
	)

Member Data Documentation

m_activeCloseBmp

wxBitmapBundle wxAuiDefaultTabArt::m_activeCloseBmp

protected

m_activeColour

wxColour wxAuiDefaultTabArt::m_activeColour

protected

m_activeLeftBmp

wxBitmapBundle wxAuiDefaultTabArt::m_activeLeftBmp

protected

m_activeRightBmp

wxBitmapBundle wxAuiDefaultTabArt::m_activeRightBmp

protected

m_activeWindowListBmp

wxBitmapBundle wxAuiDefaultTabArt::m_activeWindowListBmp

protected

m_baseColour

wxColour wxAuiDefaultTabArt::m_baseColour

protected

m_baseColourBrush

wxBrush wxAuiDefaultTabArt::m_baseColourBrush

protected

m_baseColourPen

wxPen wxAuiDefaultTabArt::m_baseColourPen

protected

m_borderPen

wxPen wxAuiDefaultTabArt::m_borderPen

protected

m_disabledCloseBmp

wxBitmapBundle wxAuiDefaultTabArt::m_disabledCloseBmp

protected

m_disabledLeftBmp

wxBitmapBundle wxAuiDefaultTabArt::m_disabledLeftBmp

protected

m_disabledRightBmp

wxBitmapBundle wxAuiDefaultTabArt::m_disabledRightBmp

protected

m_disabledWindowListBmp

wxBitmapBundle wxAuiDefaultTabArt::m_disabledWindowListBmp

protected

m_fixedTabWidth

int wxAuiDefaultTabArt::m_fixedTabWidth

protected

m_flags

unsigned int wxAuiDefaultTabArt::m_flags

protected

m_measuringFont

wxFont wxAuiDefaultTabArt::m_measuringFont

protected

The font used on the selected tab.

m_normalFont

wxFont wxAuiDefaultTabArt::m_normalFont

protected

The font used for all tabs.

m_selectedFont

wxFont wxAuiDefaultTabArt::m_selectedFont

protected

m_tabCtrlHeight

int wxAuiDefaultTabArt::m_tabCtrlHeight

protected