#include <wx/aui/auibook.h>

Inheritance diagram for wxAuiTabArt:

Detailed Description

Tab art provider defines all the drawing functions used by wxAuiNotebook.

This allows the wxAuiNotebook to have a pluggable look-and-feel.

By default, a wxAuiNotebook uses an instance of this class called wxAuiDefaultTabArt which provides bitmap art and a colour scheme that is adapted to the major platforms' look. You can either derive from that class to alter its behaviour or write a completely new tab art class.

Another example of creating a new wxAuiNotebook tab bar is wxAuiSimpleTabArt.

Call wxAuiNotebook::SetArtProvider() to make use of this new tab art.

Library: wxAui

Category: Window Docking (wxAUI)

Public Member Functions
	wxAuiTabArt ()
	Constructor. More...

virtual wxAuiTabArt *	Clone ()=0
	Clones the art object. More...

virtual void	DrawBackground (wxDC &dc, wxWindow *wnd, const wxRect &rect)=0
	Draws a background on the given area. More...

virtual void	DrawButton (wxDC &dc, wxWindow wnd, const wxRect &in_rect, int bitmap_id, int button_state, int orientation, wxRect out_rect)=0
	Draws a button. More...

virtual void	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)=0
	Draws a tab. More...

virtual int	GetBestTabCtrlSize (wxWindow *, const wxAuiNotebookPageArray &, const wxSize &)=0
	Returns the tab control size. More...

virtual int	GetIndentSize ()=0
	Returns the indent size. More...

virtual wxFont	GetNormalFont () const
	Returns the font to use for normal, non-selected, tabs. More...

virtual wxFont	GetSelectedFont () const
	Returns the font to use for the selected tab. More...

virtual wxSize	GetTabSize (wxDC &dc, wxWindow wnd, const wxString &caption, const wxBitmapBundle &bitmap, bool active, int close_button_state, int x_extent)=0
	Returns the tab size for the given caption, bitmap and state. More...

virtual void	SetFlags (unsigned int flags)=0
	Sets flags. More...

virtual void	SetMeasuringFont (const wxFont &font)=0
	Sets the font used for calculating measurements. More...

virtual void	SetNormalFont (const wxFont &font)=0
	Sets the normal font for drawing labels. More...

virtual void	SetSelectedFont (const wxFont &font)=0
	Sets the font for drawing text for selected UI elements. More...

virtual void	SetColour (const wxColour &colour)=0
	Sets the colour of the inactive tabs. More...

virtual void	SetActiveColour (const wxColour &colour)=0
	Sets the colour of the selected tab. More...

virtual void	SetSizingInfo (const wxSize &tab_ctrl_size, size_t tab_count, wxWindow *wnd=nullptr)=0
	Sets sizing information. More...

Constructor & Destructor Documentation

◆ wxAuiTabArt()

wxAuiTabArt::wxAuiTabArt ( )

Constructor.

Member Function Documentation

◆ Clone()

virtual wxAuiTabArt* wxAuiTabArt::Clone ( )

pure virtual

Clones the art object.

Implemented in wxAuiSimpleTabArt, and wxAuiDefaultTabArt.

◆ DrawBackground()

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

pure virtual

Draws a background on the given area.

Implemented in wxAuiSimpleTabArt, and wxAuiDefaultTabArt.

◆ DrawButton()

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

pure virtual

Draws a button.

Implemented in wxAuiSimpleTabArt, and wxAuiDefaultTabArt.

◆ DrawTab()

virtual void wxAuiTabArt::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
	)

pure virtual

Draws a tab.

Implemented in wxAuiSimpleTabArt, and wxAuiDefaultTabArt.

◆ GetBestTabCtrlSize()

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

pure virtual

Returns the tab control size.

Implemented in wxAuiSimpleTabArt, and wxAuiDefaultTabArt.

◆ GetIndentSize()

virtual int wxAuiTabArt::GetIndentSize ( )

pure virtual

Returns the indent size.

Implemented in wxAuiSimpleTabArt, and wxAuiDefaultTabArt.

◆ GetNormalFont()

virtual wxFont wxAuiTabArt::GetNormalFont ( ) const

virtual

Returns the font to use for normal, non-selected, tabs.

By default, returns an invalid font, meaning that the font set for wxAuiNotebook itself should be used.

This function should be overridden for SetNormalFont() to actually work.

Since: 3.3.0

◆ GetSelectedFont()

virtual wxFont wxAuiTabArt::GetSelectedFont ( ) const

virtual

Returns the font to use for the selected tab.

By default, returns an invalid font, meaning that the font set for wxAuiNotebook itself should be used.

This function should be overridden for SetSelectedFont() to actually work.

Since: 3.3.0

◆ GetTabSize()

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