auibar.AuiDefaultToolBarArt

Inheritance diagram for AuiDefaultToolBarArt:


digraph inheritanceb0f9157f1a {
rankdir=LR;
size="8.0, 12.0";
  "auibar.AuiDefaultToolBarArt" [style="setlinewidth(0.5)",URL="#auibar.AuiDefaultToolBarArt",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Description

Toolbar art provider code - a tab provider provides all drawing functionality to the AuiToolBar. This allows the AuiToolBar to have a plugable look-and-feel.

By default, a AuiToolBar uses an instance of this class called AuiDefaultToolBarArt 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. Call AuiToolBar.SetArtProvider to make use this new tab art.

Class API

Methods

class AuiDefaultToolBarArt

Bases: object

Toolbar art provider code - a tab provider provides all drawing functionality to the AuiToolBar. This allows the AuiToolBar to have a plugable look-and-feel.

By default, a AuiToolBar uses an instance of this class called AuiDefaultToolBarArt 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. Call AuiToolBar.SetArtProvider to make use this new tab art.

__init__()
Default class constructor.
Clone()
Clones the AuiToolBar art.
DrawBackground(dc, wnd, _rect, horizontal=True)

Draws a toolbar background with a gradient shading.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • _rect – the L{AuiToolBar} rectangle;
  • horizontal – True if the toolbar is horizontal, False if it is vertical.
DrawButton(dc, wnd, item, rect)

Draws a toolbar item button.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • item – an instance of L{AuiToolBarItem};
  • rect – the L{AuiToolBarItem} rectangle.
DrawControlLabel(dc, wnd, item, rect)

Draws a label for a toolbar control.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • item – an instance of L{AuiToolBarItem};
  • rect – the L{AuiToolBarItem} rectangle.
DrawDropDownButton(dc, wnd, item, rect)

Draws a toolbar dropdown button.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • item – an instance of L{AuiToolBarItem};
  • rect – the L{AuiToolBarItem} rectangle.
DrawGripper(dc, wnd, rect)

Draws the toolbar gripper.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • rect – the L{AuiToolBar} rectangle.
DrawLabel(dc, wnd, item, rect)

Draws a toolbar item label.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • item – an instance of L{AuiToolBarItem};
  • rect – the L{AuiToolBarItem} rectangle.
DrawOverflowButton(dc, wnd, rect, state)

Draws the overflow button for the L{AuiToolBar}.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • rect – the L{AuiToolBar} rectangle;
  • state – the overflow button state.
DrawPlainBackground(dc, wnd, _rect)

Draws a toolbar background with a plain colour.

This method contrasts with the default behaviour of the AuiToolBar that draws a background gradient and this break the window design when putting it within a control that has margin between the borders and the toolbar (example: put AuiToolBar within a wx.StaticBoxSizer that has a plain background).

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • _rect – the L{AuiToolBar} rectangle;
  • horizontal – True if the toolbar is horizontal, False if it is vertical.
DrawSeparator(dc, wnd, _rect)

Draws a toolbar separator.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • _rect – the L{AuiToolBarItem} rectangle.
GetElementSize(element_id)

Returns the size of a UI element in the L{AuiToolBar}.

Parameter:element_id – can be one of the following:
Element Identifier Description
AUI_TBART_SEPARATOR_SIZE Separator size in AuiToolBar
AUI_TBART_GRIPPER_SIZE Gripper size in AuiToolBar
AUI_TBART_OVERFLOW_SIZE Overflow button size in AuiToolBar
GetFlags()
Returns the L{AuiDefaultToolBarArt} flags. See L{SetFlags} for more details.
GetFont()
Returns the L{AuiDefaultToolBarArt} font.
GetLabelSize(dc, wnd, item)

Returns the label size for a toolbar item.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • item – an instance of L{AuiToolBarItem}.
GetTextOrientation()
Returns the L{AuiDefaultToolBarArt} text orientation. See L{SetTextOrientation} for more details.
GetToolSize(dc, wnd, item)

Returns the toolbar item size.

Parameters:
  • dc – a L{wx.DC} device context;
  • wnd – a wx.Window derived window;
  • item – an instance of L{AuiToolBarItem}.
SetElementSize(element_id, size)

Sets the size of a UI element in the L{AuiToolBar}.

Parameter:element_id – can be one of the following:
Element Identifier Description
AUI_TBART_SEPARATOR_SIZE Separator size in AuiToolBar
AUI_TBART_GRIPPER_SIZE Gripper size in AuiToolBar
AUI_TBART_OVERFLOW_SIZE Overflow button size in AuiToolBar
Parameter:size – the new size of the UI element.
SetFlags(flags)

Sets the toolbar art flags.

Parameter:flags – a combination of the following values:
Flag name Description
AUI_TB_TEXT Shows the text in the toolbar buttons; by default only icons are shown
AUI_TB_NO_TOOLTIPS Don’t show tooltips on AuiToolBar items
AUI_TB_NO_AUTORESIZE Do not auto-resize the AuiToolBar
AUI_TB_GRIPPER Shows a gripper on the AuiToolBar
AUI_TB_OVERFLOW The AuiToolBar can contain overflow items
AUI_TB_VERTICAL The AuiToolBar is vertical
AUI_TB_HORZ_LAYOUT Shows the text and the icons alongside, not vertically stacked. This style must be used with AUI_TB_TEXT.
AUI_TB_PLAIN_BACKGROUND Don’t draw a gradient background on the toolbar
AUI_TB_HORZ_TEXT Combination of AUI_TB_HORZ_LAYOUT and AUI_TB_TEXT
SetFont(font)

Sets the L{AuiDefaultToolBarArt} font.

Parameter:font – a wx.Font object.
SetTextOrientation(orientation)

Sets the text orientation.

Parameter:orientation – can be one of the following constants:
Orientation Switches Description
AUI_TBTOOL_TEXT_LEFT Text in AuiToolBar items is aligned left
AUI_TBTOOL_TEXT_RIGHT Text in AuiToolBar items is aligned right
AUI_TBTOOL_TEXT_TOP Text in AuiToolBar items is aligned top
AUI_TBTOOL_TEXT_BOTTOM Text in AuiToolBar items is aligned bottom
ShowDropDown(wnd, items)

Shows the drop down window menu for overflow items.

Parameters:
  • wnd – an instance of wx.Window;
  • items – the overflow toolbar items.

Table Of Contents

This Page