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¶
Known Subclasses¶
wx.aui.AuiDefaultTabArt, wx.aui.AuiSimpleTabArt
Methods Summary¶
Constructor. |
|
Clones the art object. |
|
Draws a background on the given area. |
|
Draws a button. |
|
Draws a tab. |
|
Returns the tab control size. |
|
Returns the indent size. |
|
Returns the tab size for the given caption, bitmap and state. |
|
Sets the colour of the selected tab. |
|
Sets the colour of the inactive tabs. |
|
Sets flags. |
|
Sets the font used for calculating measurements. |
|
Sets the normal font for drawing labels. |
|
Sets the font for drawing text for selected UI elements. |
|
Sets sizing information. |
Properties Summary¶
See |
Class API¶
- class wx.aui.AuiTabArt(object)¶
Possible constructors:
AuiTabArt() -> None
Tab art provider defines all the drawing functions used by AuiNotebook.
Methods¶
- __init__(self)¶
Constructor.
- Return type:
None
- Clone(self)¶
Clones the art object.
- Return type:
- DrawBackground(self, dc, wnd, rect)¶
Draws a background on the given area.
- DrawButton(self, dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect)¶
Draws a button.
- DrawTab(self, dc, wnd, page, rect, close_button_state, out_tab_rect, out_button_rect, x_extent)¶
Draws a tab.
- 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)
- Return type:
None
Added in version 2.9.2.
- SetColour(self, colour)¶
Sets the colour of the inactive tabs.
- Parameters:
colour (wx.Colour)
- Return type:
None
Added in version 2.9.2.
- SetFlags(self, flags)¶
Sets flags.
- Parameters:
flags (int)
- Return type:
None
- SetMeasuringFont(self, font)¶
Sets the font used for calculating measurements.
- Parameters:
font (wx.Font)
- Return type:
None
- SetNormalFont(self, font)¶
Sets the normal font for drawing labels.
- Parameters:
font (wx.Font)
- Return type:
None
- SetSelectedFont(self, font)¶
Sets the font for drawing text for selected UI elements.
- Parameters:
font (wx.Font)
- Return type:
None
- 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.
Properties¶
- IndentSize¶
See
GetIndentSize