wx.aui.AuiTabArt

Tab art provider defines all the drawing functions used by wx.aui.AuiNotebook.

This allows the wx.aui.AuiNotebook to have a pluggable look-and-feel.

By default, a wx.aui.AuiNotebook uses an instance of this class called wx.aui.AuiDefaultTabArt 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 wx.aui.AuiNotebook tab bar is wx.aui.AuiSimpleTabArt.

Call wx.aui.AuiNotebook.SetArtProvider to make use of this new tab art.

Class Hierarchy

Inheritance diagram for class AuiTabArt:

Known Subclasses

wx.aui.AuiDefaultTabArt, wx.aui.AuiSimpleTabArt

Methods Summary

__init__	Constructor.
Clone	Clones the art object.
DrawBackground	Draws a background on the given area.
DrawButton	Draws a button.
DrawTab	Draws a tab.
GetBestTabCtrlSize	Returns the tab control size.
GetIndentSize	Returns the indent size.
GetTabSize	Returns the tab size for the given caption, bitmap and state.
SetActiveColour	Sets the colour of the selected tab.
SetColour	Sets the colour of the inactive tabs.
SetFlags	Sets flags.
SetMeasuringFont	Sets the font used for calculating measurements.
SetNormalFont	Sets the normal font for drawing labels.
SetSelectedFont	Sets the font for drawing text for selected UI elements.
SetSizingInfo	Sets sizing information.

Properties Summary

IndentSize

See GetIndentSize

Class API

class wx.aui.AuiTabArt(object)

Possible constructors:

AuiTabArt()

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

Methods

__init__(self)

Constructor.

---

Clone(self)

Clones the art object.

Return type

wx.aui.AuiTabArt

---

DrawBackground(self, dc, wnd, rect)

Draws a background on the given area.

Parameters

• dc (wx.DC) –

• wnd (wx.Window) –

• rect (wx.Rect) –

---

DrawButton(self, dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect)

Draws a button.

Parameters

• dc (wx.DC) –

• wnd (wx.Window) –

• in_rect (wx.Rect) –

• bitmap_id (int) –

• button_state (int) –

• orientation (int) –

• out_rect (wx.Rect) –

---

DrawTab(self, dc, wnd, page, rect, close_button_state, out_tab_rect, out_button_rect, x_extent)

Draws a tab.

Parameters

• dc (wx.DC) –

• wnd (wx.Window) –

• page (wx.aui.AuiNotebookPage) –

• rect (wx.Rect) –

• close_button_state (int) –

• out_tab_rect (wx.Rect) –

• out_button_rect (wx.Rect) –

• x_extent (int) –

---

GetBestTabCtrlSize(self)

Returns the tab control size.

Parameters

`` (wx.Size) –

Return type

int

---

GetIndentSize(self)

Returns the indent size.

Return type

int

---

GetTabSize(self, dc, wnd, caption, bitmap, active, close_button_state, x_extent)

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

Parameters

• dc (wx.DC) –

• wnd (wx.Window) –

• caption (string) –

• bitmap (wx.BitmapBundle) –

• active (bool) –

• close_button_state (int) –

• x_extent (int) –

Return type

Size

---

SetActiveColour(self, colour)

Sets the colour of the selected tab.

Parameters

colour (wx.Colour) –

New in version 2.9.2.

---

SetColour(self, colour)

Sets the colour of the inactive tabs.

Parameters

colour (wx.Colour) –

New in version 2.9.2.

---

SetFlags(self, flags)

Sets flags.

Parameters

flags (int) –

---

SetMeasuringFont(self, font)

Sets the font used for calculating measurements.

Parameters

font (wx.Font) –

---

SetNormalFont(self, font)

Sets the normal font for drawing labels.

Parameters

font (wx.Font) –

---

SetSelectedFont(self, font)

Sets the font for drawing text for selected UI elements.

Parameters

font (wx.Font) –

---

SetSizingInfo(self, tab_ctrl_size, tab_count, wnd=None)

Sets sizing information.

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

Parameters

• tab_ctrl_size (wx.Size) –

• tab_count (int) –

• wnd (wx.Window) –

Properties

IndentSize

See GetIndentSize