phoenix_title wx.aui.AuiToolBar

wx.aui.AuiToolBar is a dockable toolbar, part of the AUI class framework.

See also AUI Overview.

styles Window Styles

This class supports the following styles:

  • wx.aui.AUI_TB_TEXT:

  • wx.aui.AUI_TB_NO_TOOLTIPS:

  • wx.aui.AUI_TB_NO_AUTORESIZE:

  • wx.aui.AUI_TB_GRIPPER:

  • wx.aui.AUI_TB_OVERFLOW:

  • wx.aui.AUI_TB_VERTICAL: using this style forces the toolbar to be vertical and be only dockable to the left or right sides of the window whereas by default it can be horizontal or vertical and be docked anywhere

  • wx.aui.AUI_TB_HORZ_LAYOUT:

  • wx.aui.AUI_TB_HORIZONTAL: analogous to wx.aui.AUI_TB_VERTICAL, but forces the toolbar to be horizontal

  • wx.aui.AUI_TB_PLAIN_BACKGROUND: Draw a plain background (based on parent) instead of the default gradient background.

  • wx.aui.AUI_TB_HORZ_TEXT: Equivalent to wx.aui.AUI_TB_HORZ_LAYOUT | wx.aui.AUI_TB_TEXT

  • wx.aui.AUI_TB_DEFAULT_STYLE: The default is to have no styles

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.aui.AuiToolBarEvent parameter.

  • EVT_AUITOOLBAR_TOOL_DROPDOWN: Process a wxEVT_AUITOOLBAR_TOOL_DROPDOWN event

  • EVT_AUITOOLBAR_OVERFLOW_CLICK: Process a wxEVT_AUITOOLBAR_OVERFLOW_CLICK event

  • EVT_AUITOOLBAR_RIGHT_CLICK: Process a wxEVT_AUITOOLBAR_RIGHT_CLICK event

  • EVT_AUITOOLBAR_MIDDLE_CLICK: Process a wxEVT_AUITOOLBAR_MIDDLE_CLICK event

  • EVT_AUITOOLBAR_BEGIN_DRAG: Process a wxEVT_AUITOOLBAR_BEGIN_DRAG event


class_hierarchy Class Hierarchy

Inheritance diagram for class AuiToolBar:

method_summary Methods Summary

__init__

Default constructor, use Create later.

AddControl

AddLabel

AddSeparator

AddSpacer

AddStretchSpacer

AddTool

Clear

ClearTools

Create

Really create wx.aui.AuiToolBar created using default constructor.

DeleteByIndex

DeleteTool

EnableTool

FindControl

FindTool

FindToolByIndex

FindToolByPosition

GetArtProvider

GetClassDefaultAttributes

GetGripperVisible

GetHintSize

get size of hint rectangle for a particular dock location

GetOverflowVisible

GetToolBarFits

GetToolBitmap

GetToolBitmapSize

GetToolBorderPadding

GetToolCount

GetToolDropDown

Returns whether the specified toolbar item has an associated drop down button.

GetToolEnabled

GetToolFits

GetToolFitsByIndex

GetToolIndex

GetToolLabel

GetToolLongHelp

GetToolPacking

GetToolPos

GetToolProportion

GetToolRect

GetToolSeparation

GetToolShortHelp

GetToolSticky

GetToolTextOrientation

GetToolToggled

GetWindowStyleFlag

Gets the window style that was passed to the constructor or Create method.

IsPaneValid

Realize

SetArtProvider

SetCustomOverflowItems

SetFont

Sets the font for this window.

SetGripperVisible

SetMargins

SetOverflowVisible

SetToolBitmap

SetToolBitmapSize

SetToolBorderPadding

SetToolDropDown

Set whether the specified toolbar item has a drop down button.

SetToolLabel

SetToolLongHelp

SetToolPacking

SetToolProportion

SetToolSeparation

SetToolShortHelp

SetToolSticky

SetToolTextOrientation

SetWindowStyleFlag

Sets the style of the window.

ToggleTool


property_summary Properties Summary

ArtProvider

See GetArtProvider and SetArtProvider

GripperVisible

See GetGripperVisible and SetGripperVisible

OverflowVisible

See GetOverflowVisible and SetOverflowVisible

ToolBarFits

See GetToolBarFits

ToolBitmapSize

See GetToolBitmapSize and SetToolBitmapSize

ToolBorderPadding

See GetToolBorderPadding and SetToolBorderPadding

ToolCount

See GetToolCount

ToolPacking

See GetToolPacking and SetToolPacking

ToolSeparation

See GetToolSeparation and SetToolSeparation

ToolTextOrientation

See GetToolTextOrientation and SetToolTextOrientation

WindowStyleFlag

See GetWindowStyleFlag and SetWindowStyleFlag


api Class API

class wx.aui.AuiToolBar(Control)

Possible constructors:

AuiToolBar()

AuiToolBar(parent, id=ID_ANY, position=DefaultPosition,
           size=DefaultSize, style=AUI_TB_DEFAULT_STYLE)

AuiToolBar is a dockable toolbar, part of the AUI class framework.

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor, use Create later.

New in version 2.9.5.



__init__ (self, parent, id=ID_ANY, position=DefaultPosition, size=DefaultSize, style=AUI_TB_DEFAULT_STYLE)

Constructor creating and initializing the object.

Parameters



AddControl(self, control, label='')
Parameters
Return type

wx.aui.AuiToolBarItem

AddLabel(self, tool_id, label='', width=- 1)
Parameters
  • tool_id (int) –

  • label (string) –

  • width (int) –

Return type

wx.aui.AuiToolBarItem

AddSeparator(self)
Return type

wx.aui.AuiToolBarItem

AddSpacer(self, pixels)
Parameters

pixels (int) –

Return type

wx.aui.AuiToolBarItem

AddStretchSpacer(self, proportion=1)
Parameters

proportion (int) –

Return type

wx.aui.AuiToolBarItem

AddTool(self, *args, **kw)

overload Overloaded Implementations:



AddTool (self, tool_id, label, bitmap, short_help_string=””, kind=ITEM_NORMAL)

Parameters
  • tool_id (int) –

  • label (string) –

  • bitmap (wx.Bitmap) –

  • short_help_string (string) –

  • kind (ItemKind) –

Return type

wx.aui.AuiToolBarItem



AddTool (self, tool_id, label, bitmap, disabled_bitmap, kind, short_help_string, long_help_string, client_data)

Parameters
  • tool_id (int) –

  • label (string) –

  • bitmap (wx.Bitmap) –

  • disabled_bitmap (wx.Bitmap) –

  • kind (ItemKind) –

  • short_help_string (string) –

  • long_help_string (string) –

  • client_data (wx.Object) –

Return type

wx.aui.AuiToolBarItem



AddTool (self, tool_id, bitmap, disabled_bitmap, toggle=False, client_data=None, short_help_string=””, long_help_string=””)

Parameters
  • tool_id (int) –

  • bitmap (wx.Bitmap) –

  • disabled_bitmap (wx.Bitmap) –

  • toggle (bool) –

  • client_data (wx.Object) –

  • short_help_string (string) –

  • long_help_string (string) –

Return type

wx.aui.AuiToolBarItem



Clear(self)
ClearTools(self)
Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=AUI_TB_DEFAULT_STYLE)

Really create wx.aui.AuiToolBar created using default constructor.

Parameters
Return type

bool

New in version 2.9.5.

DeleteByIndex(self, tool_id)
Parameters

tool_id (int) –

Return type

bool

DeleteTool(self, tool_id)
Parameters

tool_id (int) –

Return type

bool

EnableTool(self, tool_id, state)
Parameters
  • tool_id (int) –

  • state (bool) –

FindControl(self, window_id)
Parameters

window_id (int) –

Return type

Control

FindTool(self, tool_id)
Parameters

tool_id (int) –

Return type

wx.aui.AuiToolBarItem

FindToolByIndex(self, idx)
Parameters

idx (int) –

Return type

wx.aui.AuiToolBarItem

FindToolByPosition(self, x, y)
Parameters
  • x (int) –

  • y (int) –

Return type

wx.aui.AuiToolBarItem

GetArtProvider(self)
Return type

wx.aui.AuiToolBarArt

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

VisualAttributes

GetGripperVisible(self)
Return type

bool

GetHintSize(self, dock_direction)

get size of hint rectangle for a particular dock location

Parameters

dock_direction (int) –

Return type

Size

GetOverflowVisible(self)
Return type

bool

GetToolBarFits(self)
Return type

bool

GetToolBitmap(self, tool_id)
Parameters

tool_id (int) –

Return type

Bitmap

GetToolBitmapSize(self)
Return type

Size

GetToolBorderPadding(self)
Return type

int

GetToolCount(self)
Return type

int

GetToolDropDown(self, tool_id)

Returns whether the specified toolbar item has an associated drop down button.

Parameters

tool_id (int) –

Return type

bool

GetToolEnabled(self, tool_id)
Parameters

tool_id (int) –

Return type

bool

GetToolFits(self, tool_id)
Parameters

tool_id (int) –

Return type

bool

GetToolFitsByIndex(self, tool_id)
Parameters

tool_id (int) –

Return type

bool

GetToolIndex(self, tool_id)
Parameters

tool_id (int) –

Return type

int

GetToolLabel(self, tool_id)
Parameters

tool_id (int) –

Return type

string

GetToolLongHelp(self, tool_id)
Parameters

tool_id (int) –

Return type

string

GetToolPacking(self)
Return type

int

GetToolPos(self, tool_id)
Parameters

tool_id (int) –

Return type

int

GetToolProportion(self, tool_id)
Parameters

tool_id (int) –

Return type

int

GetToolRect(self, tool_id)
Parameters

tool_id (int) –

Return type

Rect

GetToolSeparation(self)
Return type

int

GetToolShortHelp(self, tool_id)
Parameters

tool_id (int) –

Return type

string

GetToolSticky(self, tool_id)
Parameters

tool_id (int) –

Return type

bool

GetToolTextOrientation(self)
Return type

int

GetToolToggled(self, tool_id)
Parameters

tool_id (int) –

Return type

bool

GetWindowStyleFlag(self)

Gets the window style that was passed to the constructor or Create method.

GetWindowStyle is another name for the same function.

Return type

long

IsPaneValid(self, pane)
Parameters

pane (wx.aui.AuiPaneInfo) –

Return type

bool

Realize(self)
Return type

bool

SetArtProvider(self, art)
Parameters

art (wx.aui.AuiToolBarArt) –

SetCustomOverflowItems(self, prepend, append)
Parameters
  • prepend (AuiToolBarItemArray) –

  • append (AuiToolBarItemArray) –

SetFont(self, font)

Sets the font for this window.

This function should not be called for the parent window if you don’t want its font to be inherited by its children, use SetOwnFont instead in this case and see InheritAttributes for more explanations.

Please notice that the given font is not automatically used for wx.PaintDC objects associated with this window, you need to call wx.DC.SetFont too. However this font is used by any standard controls for drawing their text as well as by GetTextExtent .

Parameters

font (wx.Font) – Font to associate with this window, pass NullFont to reset to the default font.

Return type

bool

Returns

True if the font was really changed, False if it was already set to this font and nothing was done.

See also

GetFont , InheritAttributes

SetGripperVisible(self, visible)
Parameters

visible (bool) –

SetMargins(self, *args, **kw)

overload Overloaded Implementations:



SetMargins (self, size)

Parameters

size (wx.Size) –



SetMargins (self, x, y)

Parameters
  • x (int) –

  • y (int) –



SetMargins (self, left, right, top, bottom)

Parameters
  • left (int) –

  • right (int) –

  • top (int) –

  • bottom (int) –



SetOverflowVisible(self, visible)
Parameters

visible (bool) –

SetToolBitmap(self, tool_id, bitmap)
Parameters
SetToolBitmapSize(self, size)
Parameters

size (wx.Size) –

SetToolBorderPadding(self, padding)
Parameters

padding (int) –

SetToolDropDown(self, tool_id, dropdown)

Set whether the specified toolbar item has a drop down button.

This is only valid for wx.ITEM_NORMAL tools.

Parameters
  • tool_id (int) –

  • dropdown (bool) –

SetToolLabel(self, tool_id, label)
Parameters
  • tool_id (int) –

  • label (string) –

SetToolLongHelp(self, tool_id, help_string)
Parameters
  • tool_id (int) –

  • help_string (string) –

SetToolPacking(self, packing)
Parameters

packing (int) –

SetToolProportion(self, tool_id, proportion)
Parameters
  • tool_id (int) –

  • proportion (int) –

SetToolSeparation(self, separation)
Parameters

separation (int) –

SetToolShortHelp(self, tool_id, help_string)
Parameters
  • tool_id (int) –

  • help_string (string) –

SetToolSticky(self, tool_id, sticky)
Parameters
  • tool_id (int) –

  • sticky (bool) –

SetToolTextOrientation(self, orientation)
Parameters

orientation (int) –

SetWindowStyleFlag(self, style)

Sets the style of the window.

Please note that some styles cannot be changed after the window creation and that Refresh might need to be called after changing the others for the change to take place immediately.

See Window styles for more information about flags.

Parameters

style (long) –

ToggleTool(self, tool_id, state)
Parameters
  • tool_id (int) –

  • state (bool) –

ArtProvider

See GetArtProvider and SetArtProvider

GripperVisible

See GetGripperVisible and SetGripperVisible

OverflowVisible

See GetOverflowVisible and SetOverflowVisible

ToolBarFits

See GetToolBarFits

ToolBitmapSize

See GetToolBitmapSize and SetToolBitmapSize

ToolBorderPadding

See GetToolBorderPadding and SetToolBorderPadding

ToolCount

See GetToolCount

ToolPacking

See GetToolPacking and SetToolPacking

ToolSeparation

See GetToolSeparation and SetToolSeparation

ToolTextOrientation

See GetToolTextOrientation and SetToolTextOrientation

WindowStyleFlag

See GetWindowStyleFlag and SetWindowStyleFlag