wx.aui.AuiToolBar¶

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

Window Styles¶

This class supports the following styles:

wx.aui.AUI_TB_TEXT: Display the label strings on the toolbar buttons.
wx.aui.AUI_TB_NO_TOOLTIPS: Do not show tooltips for the toolbar items.
wx.aui.AUI_TB_NO_AUTORESIZE: Do not automatically resize the toolbar when new tools are added.
wx.aui.AUI_TB_GRIPPER: Show the toolbar’s gripper control. If the toolbar is added to an AUI pane that contains a gripper, this style will be automatically set.
wx.aui.AUI_TB_OVERFLOW: Show an overflow menu containing toolbar items that can’t fit on the toolbar if it is too small.
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 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¶

Inheritance diagram for class AuiToolBar:

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`	Removes the tool at the given position from the toolbar.
`DeleteTool`	Removes the tool with the given `ID` from the toolbar.
`DestroyTool`	Destroys the tool with the given `ID` and its associated window, if any.
`DestroyToolByIndex`	Destroys the tool at the given position and its associated window, if any.
`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`	Add toolbar items that are always displayed in the overflow menu.
`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`

Properties Summary¶

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.

Methods¶

__init__(self, *args, **kw)¶

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:

parent (wx.Window) –
id (wx.WindowID) –
position (wx.Point) –
size (wx.Size) –
style (long) –

AddControl(self, control, label="")¶

Parameters:

control (wx.Control) –
label (string) –

Return type:

wx.aui.AuiToolBarItem

AddLabel(self, toolId, label="", width=-1)¶

Parameters:

toolId (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)¶

Overloaded Implementations:

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

Parameters:

toolId (int) –
label (string) –
bitmap (wx.BitmapBundle) –
short_help_string (string) –
kind (ItemKind) –

Return type:

wx.aui.AuiToolBarItem

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

Parameters:

toolId (int) –
label (string) –
bitmap (wx.BitmapBundle) –
disabled_bitmap (wx.BitmapBundle) –
kind (ItemKind) –
short_help_string (string) –
long_help_string (string) –
client_data (wx.Object) –

Return type:

wx.aui.AuiToolBarItem

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

Parameters:

toolId (int) –
bitmap (wx.BitmapBundle) –
disabled_bitmap (wx.BitmapBundle) –
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:

parent (wx.Window) –
id (wx.WindowID) –
pos (wx.Point) –
size (wx.Size) –
style (long) –

Return type:

bool

New in version 2.9.5.

DeleteByIndex(self, idx)¶

Removes the tool at the given position from the toolbar.

Note that if this tool was added by AddControl , the associated control is not deleted and must either be reused (e.g. by reparenting it under a different window) or destroyed by caller. If this behaviour is unwanted, prefer using DestroyToolByIndex instead.

Parameters:: idx (int) – The index, or position, of a previously added tool.
Return type:: bool
Returns:: True if the tool was removed or False otherwise, e.g. if the provided index is out of range.

DeleteTool(self, toolId)¶

Removes the tool with the given ID from the toolbar.

Note that if this tool was added by AddControl , the associated control is not deleted and must either be reused (e.g. by reparenting it under a different window) or destroyed by caller. If this behaviour is unwanted, prefer using DestroyTool instead.

Parameters:: toolId (int) – ID of a previously added tool.
Return type:: bool
Returns:: True if the tool was removed or False otherwise, e.g. if the tool with the given ID was not found.

DestroyTool(self, toolId)¶

Destroys the tool with the given ID and its associated window, if any.

Parameters:: toolId (int) – ID of a previously added tool.
Return type:: bool
Returns:: True if the tool was destroyed or False otherwise, e.g. if the tool with the given ID was not found.

New in version 4.1/wxWidgets-3.1.4.

DestroyToolByIndex(self, idx)¶

Destroys the tool at the given position and its associated window, if any.

Parameters:: idx (int) – The index, or position, of a previously added tool.
Return type:: bool
Returns:: True if the tool was destroyed or False otherwise, e.g. if the provided index is out of range.

EnableTool(self, toolId, state)¶

Parameters:

toolId (int) –
state (bool) –

FindControl(self, window_id)¶

Parameters:: window_id (int) –
Return type:: Control

FindTool(self, toolId)¶

Parameters:: toolId (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, toolId)¶

Parameters:: toolId (int) –
Return type:: Bitmap

GetToolBitmapSize(self)¶

Return type:: Size

GetToolBorderPadding(self)¶

Return type:: int

GetToolCount(self)¶

Return type:: int

GetToolDropDown(self, toolId)¶

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

Parameters:: toolId (int) –
Return type:: bool

See also

wx.aui.AuiToolBarItem.HasDropDown

GetToolEnabled(self, toolId)¶

Parameters:: toolId (int) –
Return type:: bool

GetToolFits(self, toolId)¶

Parameters:: toolId (int) –
Return type:: bool

GetToolFitsByIndex(self, toolId)¶

Parameters:: toolId (int) –
Return type:: bool

GetToolIndex(self, toolId)¶

Parameters:: toolId (int) –
Return type:: int

GetToolLabel(self, toolId)¶

Parameters:: toolId (int) –
Return type:: string

GetToolLongHelp(self, toolId)¶

Parameters:: toolId (int) –
Return type:: string

GetToolPacking(self)¶

Return type:: int

GetToolPos(self, toolId)¶

Parameters:: toolId (int) –
Return type:: int

GetToolProportion(self, toolId)¶

Parameters:: toolId (int) –
Return type:: int

GetToolRect(self, toolId)¶

Parameters:: toolId (int) –
Return type:: Rect

GetToolSeparation(self)¶

Return type:: int

GetToolShortHelp(self, toolId)¶

Parameters:: toolId (int) –
Return type:: string

GetToolSticky(self, toolId)¶

Parameters:: toolId (int) –
Return type:: bool

GetToolTextOrientation(self)¶

Return type:: int

GetToolToggled(self, toolId)¶

Parameters:: toolId (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)¶

Add toolbar items that are always displayed in the overflow menu.

If there are custom items set, then the overflow menu will be displayed even if there are no items from the main toolbar that overflow.

Parameters:

prepend (AuiToolBarItemArray) – are the items to show before any overflow items
append (AuiToolBarItemArray) – are the items to show after any overflow items

Note

The toolbar must have the AUI_TB_OVERFLOW style.

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)¶

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, toolId, bitmap)¶

Parameters:

toolId (int) –
bitmap (wx.BitmapBundle) –

SetToolBitmapSize(self, size)¶

Parameters:: size (wx.Size) –

SetToolBorderPadding(self, padding)¶

Parameters:: padding (int) –

SetToolDropDown(self, toolId, dropdown)¶

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

This is only valid for wx.ITEM_NORMAL tools.

Parameters:

toolId (int) –
dropdown (bool) –

See also

wx.aui.AuiToolBarItem.SetHasDropDown

SetToolLabel(self, toolId, label)¶

Parameters:

toolId (int) –
label (string) –

SetToolLongHelp(self, toolId, help_string)¶

Parameters:

toolId (int) –
help_string (string) –

SetToolPacking(self, packing)¶

Parameters:: packing (int) –

SetToolProportion(self, toolId, proportion)¶

Parameters:

toolId (int) –
proportion (int) –

SetToolSeparation(self, separation)¶

Parameters:: separation (int) –

SetToolShortHelp(self, toolId, help_string)¶

Parameters:

toolId (int) –
help_string (string) –

SetToolSticky(self, toolId, sticky)¶

Parameters:

toolId (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) –

See also

GetWindowStyleFlag

ToggleTool(self, toolId, state)¶

Parameters:

toolId (int) –
state (bool) –

Properties¶

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

`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`

Navigation

wx.aui.AuiToolBar¶

Window Styles¶

Events Emitted by this Class¶

Class Hierarchy¶

Methods Summary¶

Properties Summary¶

Class API¶

Methods¶

Properties¶