wx.ToolBar

A toolbar is a bar of buttons and/or other controls usually placed below the menu bar in a wx.Frame.

You may create a toolbar that is managed by a frame calling wx.Frame.CreateToolBar . Under Pocket PC, you should always use this function for creating the toolbar to be managed by the frame, so that wxWidgets can use a combined menubar and toolbar. Where you manage your own toolbars, create wx.ToolBar as usual.

There are several different types of tools you can add to a toolbar. These types are controlled by the wx.ItemKind enumeration.

Note that many methods in wx.ToolBar such as wx.ToolBar.AddTool return a ToolBarToolBase* object. This should be regarded as an opaque handle representing the newly added toolbar item, providing access to its id and position within the toolbar. Changes to the item’s state should be made through calls to wx.ToolBar methods, for example wx.ToolBar.EnableTool . Calls to wx.ToolBarToolBase methods (undocumented by purpose) will not change the visible state of the item within the tool bar.

wxMSW note: Note that under wxMSW toolbar paints tools to reflect system-wide colours. If you use more than 16 colours in your tool bitmaps, you may wish to suppress this behaviour, otherwise system colours in your bitmaps will inadvertently be mapped to system colours. To do this, set the msw.remap system option before creating the toolbar:

wx.SystemOptions.SetOption("msw.remap", 0)

If you wish to use 32-bit images (which include an alpha channel for transparency) use:

wx.SystemOptions.SetOption("msw.remap", 2)

Then colour remapping is switched off, and a transparent background used. But only use this option under Windows XP with True colour:

if wx.GetApp().GetComCtl32Version() >= 600 and wx.DisplayDepth() >= 32:
    # Use the 32-bit images
    wx.SystemOptions.SetOption("msw.remap", 2)

 Window Styles

This class supports the following styles:

• wx.TB_FLAT: Gives the toolbar a flat look (Windows and GTK only).
• wx.TB_DOCKABLE: Makes the toolbar floatable and dockable (GTK only).
• wx.TB_HORIZONTAL: Specifies horizontal layout (default).
• wx.TB_VERTICAL: Specifies vertical layout.
• wx.TB_TEXT: Shows the text in the toolbar buttons; by default only icons are shown.
• wx.TB_NOICONS: Specifies no icons in the toolbar buttons; by default they are shown.
• wx.TB_NODIVIDER: Specifies no divider (border) above the toolbar (Windows only)
• wx.TB_NOALIGN: Specifies no alignment with the parent window (Windows only, not very useful).
• wx.TB_HORZ_LAYOUT: Shows the text and the icons alongside, not vertically stacked (Windows and GTK 2 only). This style must be used with TB_TEXT .
• wx.TB_HORZ_TEXT: Combination of TB_HORZ_LAYOUT and TB_TEXT .
• wx.TB_NO_TOOLTIPS: Don’t show the short help tooltips for the tools when the mouse hovers over them.
• wx.TB_BOTTOM: Align the toolbar at the bottom of parent window.
• wx.TB_RIGHT: Align the toolbar at the right side of parent window.
• wx.TB_DEFAULT_STYLE: Combination of TB_HORIZONTAL and TB_FLAT . This style is new since wxWidgets 2.9.5.

See also

Window Styles. Note that the wxMSW native toolbar ignores TB_NOICONS style. Also, toggling the TB_TEXT works only if the style was initially on.

 Events Emitted by this Class

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

• EVT_TOOL: Process a wxEVT_TOOL event (a synonym for wxEVT_MENU ). Pass the id of the tool.
• EVT_MENU: The same as EVT_TOOL().
• EVT_TOOL_RANGE: Process a wxEVT_TOOL event for a range of identifiers. Pass the ids of the tools.
• EVT_MENU_RANGE: The same as EVT_TOOL_RANGE().
• EVT_TOOL_RCLICKED: Process a wxEVT_TOOL_RCLICKED event. Pass the id of the tool. (Not available on wxOSX.)
• EVT_TOOL_RCLICKED_RANGE: Process a wxEVT_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.)
• EVT_TOOL_ENTER: Process a wxEVT_TOOL_ENTER event. Pass the id of the toolbar itself. The value of wx.CommandEvent.GetSelection is the tool id, or -1 if the mouse cursor has moved off a tool. (Not available on wxOSX.)
• EVT_TOOL_DROPDOWN: Process a wxEVT_TOOL_DROPDOWN event. If unhandled, displays the default dropdown menu set using wx.ToolBar.SetDropdownMenu .

The toolbar class emits menu commands in the same way that a frame menubar does, so you can use one EVT_MENU() macro for both a menu item and a toolbar button. The event handler functions take a wx.CommandEvent argument. For most event macros, the identifier of the tool is passed, but for EVT_TOOL_ENTER() the toolbar window identifier is passed and the tool identifier is retrieved from the wx.CommandEvent. This is because the identifier may beID_ANY when the mouse moves off a tool, and ID_ANY is not allowed as an identifier in the event system.

See also

Toolbar Overview

 Class Hierarchy

 Inheritance diagram for class ToolBar:

 Methods Summary

 Properties Summary

 Class API

class wx.ToolBar(Control)

Possible constructors:

ToolBar()

ToolBar(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
        style=TB_HORIZONTAL, name=ToolBarNameStr)

A toolbar is a bar of buttons and/or other controls usually placed below the menu bar in a Frame.

Methods

---

__init__(self, *args, **kw)

 Overloaded Implementations:

---

__init__ (self)

Default constructor.

---

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TB_HORIZONTAL, name=ToolBarNameStr)

Constructs a toolbar.

Parameters:

parent (wx.Window) – Pointer to a parent window. id (wx.WindowID) – Window identifier. If -1, will automatically create an identifier. pos (wx.Point) – Window position. wx.DefaultPosition indicates that wxWidgets should generate a default position for the window. If using the wx.Window class directly, supply an actual position. size (wx.Size) – Window size. wx.DefaultSize indicates that wxWidgets should generate a default size for the window. style (long) – Window style. See wx.ToolBar initial description for details. name (string) – Window name.

Note

After a toolbar is created, you use AddTool and perhaps AddSeparator , and then you must call Realize to construct and display the toolbar tools.

---

---

AddCheckTool(self, toolId, label, bitmap1, bmpDisabled=NullBitmap, shortHelp="", longHelp="", clientData=None)

Adds a new check (or toggle) tool to the toolbar.

The parameters are the same as in AddTool .

Parameters:	toolId (int) – label (string) – bitmap1 (wx.Bitmap) – bmpDisabled (wx.Bitmap) – shortHelp (string) – longHelp (string) – clientData (PyUserData) –
Return type:	wx.ToolBarToolBase

See also

AddTool

---

AddControl(self, control, label="")

Adds any control to the toolbar, typically e.g. a wx.ComboBox.

Parameters:	control (wx.Control) – The control to be added. label (string) – Text to be displayed near the control.
Return type:	wx.ToolBarToolBase

Note

wxMSW: the label is only displayed if there is enough space available below the embedded control.

Note

Mac: labels are only displayed if wxWidgets is built with MAC_USE_NATIVE_TOOLBAR set to 1

---

AddLabelTool(self, id, label, bitmap, bmpDisabled=wx.NullBitmap, kind=wx.ITEM_NORMAL, shortHelp="", longHelp="", clientData=None)

Old style method to add a tool in the toolbar.

Deprecated since version 3.0.3: Use AddTool instead.

---

AddRadioTool(self, toolId, label, bitmap1, bmpDisabled=NullBitmap, shortHelp="", longHelp="", clientData=None)

Adds a new radio tool to the toolbar.

Consecutive radio tools form a radio group such that exactly one button in the group is pressed at any moment, in other words whenever a button in the group is pressed the previously pressed button is automatically released. You should avoid having the radio groups of only one element as it would be impossible for the user to use such button.

By default, the first button in the radio group is initially pressed, the others are not.

Parameters:	toolId (int) – label (string) – bitmap1 (wx.Bitmap) – bmpDisabled (wx.Bitmap) – shortHelp (string) – longHelp (string) – clientData (PyUserData) –
Return type:	wx.ToolBarToolBase

See also

AddTool

---

AddSeparator(self)

Adds a separator for spacing groups of tools.

Notice that the separator uses the look appropriate for the current platform so it can be a vertical line (MSW, some versions of GTK) or just an empty space or something else.

Return type:	wx.ToolBarToolBase

See also

AddTool , SetToolSeparation , AddStretchableSpace

---

AddSimpleTool(self, toolId, bitmap, shortHelpString="", longHelpString="", isToggle=0)

Old style method to add a tool to the toolbar.

Deprecated since version 3.0.3: Use AddTool instead.

---

AddStretchableSpace(self)

Adds a stretchable space to the toolbar.

Any space not taken up by the fixed items (all items except for stretchable spaces) is distributed in equal measure between the stretchable spaces in the toolbar. The most common use for this method is to add a single stretchable space before the items which should be right-aligned in the toolbar, but more exotic possibilities are possible, e.g. a stretchable space may be added in the beginning and the end of the toolbar to centre all toolbar items.

Return type:	wx.ToolBarToolBase

New in version 2.9.1.

See also

AddTool , AddSeparator , InsertStretchableSpace

---

AddTool(self, *args, **kw)

 Overloaded Implementations:

---

AddTool (self, tool)

Adds a tool to the toolbar.

Parameters:	tool (wx.ToolBarToolBase) – The tool to be added.
Return type:	wx.ToolBarToolBase

Note

After you have added tools to a toolbar, you must call Realize in order to have the tools appear.

See also

AddSeparator , AddCheckTool , AddRadioTool , InsertTool , DeleteTool , Realize , SetDropdownMenu

---

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

Adds a tool to the toolbar.

This most commonly used version has fewer parameters than the full version below which specifies the more rarely used button features.

Parameters:

toolId (int) – An integer by which the tool may be identified in subsequent operations. label (string) – The string to be displayed with the tool. bitmap (wx.Bitmap) – The primary tool bitmap. shortHelp (string) – This string is used for the tools tooltip. kind (ItemKind) – May be ITEM_NORMAL for a normal button (default), ITEM_CHECK for a checkable tool (such tool stays pressed after it had been toggled) or ITEM_RADIO for a checkable tool which makes part of a radio group of tools each of which is automatically unchecked whenever another button in the group is checked. ITEM_DROPDOWN specifies that a drop-down menu button will appear next to the tool button (only GTK+ and MSW). Call SetDropdownMenu afterwards.

Return type:

wx.ToolBarToolBase

Note

After you have added tools to a toolbar, you must call Realize in order to have the tools appear.

See also

AddSeparator , AddCheckTool , AddRadioTool , InsertTool , DeleteTool , Realize , SetDropdownMenu

---

AddTool (self, toolId, label, bitmap, bmpDisabled, kind=ITEM_NORMAL, shortHelpString=””, longHelpString=””, clientData=None)

Adds a tool to the toolbar.

Parameters:

toolId (int) – An integer by which the tool may be identified in subsequent operations. label (string) – The string to be displayed with the tool. bitmap (wx.Bitmap) – The primary tool bitmap. bmpDisabled (wx.Bitmap) – The bitmap used when the tool is disabled. If it is equal to wx.NullBitmap (default), the disabled bitmap is automatically generated by greying the normal one. kind (ItemKind) – May be ITEM_NORMAL for a normal button (default), ITEM_CHECK for a checkable tool (such tool stays pressed after it had been toggled) or ITEM_RADIO for a checkable tool which makes part of a radio group of tools each of which is automatically unchecked whenever another button in the group is checked. ITEM_DROPDOWN specifies that a drop-down menu button will appear next to the tool button (only GTK+ and MSW). Call SetDropdownMenu afterwards. shortHelpString (string) – This string is used for the tools tooltip. longHelpString (string) – This string is shown in the statusbar (if any) of the parent frame when the mouse pointer is inside the tool. clientData (PyUserData) – An optional pointer to client data which can be retrieved later using GetToolClientData .

Return type:

wx.ToolBarToolBase

Note

After you have added tools to a toolbar, you must call Realize in order to have the tools appear.

See also

AddSeparator , AddCheckTool , AddRadioTool , InsertTool , DeleteTool , Realize , SetDropdownMenu

---

---

ClearTools(self)

Deletes all the tools in the toolbar.

---

CreateTool(self, *args, **kw)

 Overloaded Implementations:

---

CreateTool (self, toolId, label, bmpNormal, bmpDisabled=NullBitmap, kind=ITEM_NORMAL, clientData=None, shortHelp=””, longHelp=””)

Factory function to create a new toolbar tool.

Parameters:	toolId (int) – label (string) – bmpNormal (wx.Bitmap) – bmpDisabled (wx.Bitmap) – kind (ItemKind) – clientData (PyUserData) – shortHelp (string) – longHelp (string) –
Return type:	wx.ToolBarToolBase

---

CreateTool (self, control, label)

Factory function to create a new control toolbar tool.

Parameters:	control (wx.Control) – label (string) –
Return type:	wx.ToolBarToolBase

---

---

DeleteTool(self, toolId)

Removes the specified tool from the toolbar and deletes it.

If you don’t want to delete the tool, but just to remove it from the toolbar (to possibly add it back later), you may use RemoveTool instead.

Parameters:	toolId (int) –
Return type:	bool
Returns:	True if the tool was deleted, False otherwise.

Note

It is unnecessary to call Realize for the change to take place, it will happen immediately.

See also

DeleteToolByPos

---

DeleteToolByPos(self, pos)

This function behaves like DeleteTool but it deletes the tool at the specified position and not the one with the given id.

Parameters:	pos (int) –
Return type:	bool

---

EnableTool(self, toolId, enable)

Enables or disables the tool.

Parameters:	toolId (int) – ID of the tool to enable or disable, as passed to AddTool . enable (bool) – If True, enables the tool, otherwise disables it.

Note

Some implementations will change the visible state of the tool to indicate that it is disabled.

See also

GetToolEnabled , ToggleTool

---

FindById(self, id)

Returns a pointer to the tool identified by id or None if no corresponding tool is found.

Parameters:	id (int) –
Return type:	wx.ToolBarToolBase

---

FindControl(self, id)

Returns a pointer to the control identified by id or None if no corresponding control is found.

Parameters:	id (int) –
Return type:	wx.Control

---

FindToolForPosition(self, x, y)

Finds a tool for the given mouse position.

Parameters:	x (int) – X position. y (int) – Y position.
Return type:	wx.ToolBarToolBase
Returns:	A pointer to a tool if a tool is found, or None otherwise.

Note

Currently not implemented in wxGTK (always returns None there).

---

GetMargins(self)

Returns the left/right and top/bottom margins, which are also used for inter-toolspacing.

Return type:	wx.Size

See also

SetMargins

---

GetToolBitmapSize(self)

Returns the size of bitmap that the toolbar expects to have.

The default bitmap size is platform-dependent: for example, it is 16x15 for MSW and 24x24 for GTK. This size does not necessarily indicate the best size to use for the toolbars on the given platform, for this you should use ArtProvider::GetNativeSizeHint(wxART_TOOLBAR) but in any case, as the bitmap size is deduced automatically from the size of the bitmaps associated with the tools added to the toolbar, it is usually unnecessary to call SetToolBitmapSize explicitly.

Return type:	wx.Size

Note

Note that this is the size of the bitmap you pass to AddTool , and not the eventual size of the tool button.

See also

SetToolBitmapSize , GetToolSize

---

GetToolByPos(self, pos)

Returns a pointer to the tool at ordinal position pos.

Don’t confuse this with FindToolForPosition .

Parameters:	pos (int) –
Return type:	wx.ToolBarToolBase

New in version 2.9.1.

See also

GetToolsCount

---

GetToolClientData(self, toolId)

Get any client data associated with the tool.

Parameters:	toolId (int) – ID of the tool in question, as passed to AddTool .
Return type:	PyUserData
Returns:	Client data, or None if there is none.

---

GetToolEnabled(self, toolId)

Called to determine whether a tool is enabled (responds to user input).

Parameters:	toolId (int) – ID of the tool in question, as passed to AddTool .
Return type:	bool
Returns:	True if the tool is enabled, False otherwise.

See also

EnableTool

---

GetToolLongHelp(self, toolId)

Returns the long help for the given tool.

Parameters:	toolId (int) – ID of the tool in question, as passed to AddTool .
Return type:	string

See also

SetToolLongHelp , SetToolShortHelp

---

GetToolPacking(self)

Returns the value used for packing tools.

Return type:	int

See also

SetToolPacking

---

GetToolPos(self, toolId)

Returns the tool position in the toolbar, or NOT_FOUND if the tool is not found.

Parameters:	toolId (int) – ID of the tool in question, as passed to AddTool .
Return type:	int

---

GetToolSeparation(self)

Returns the default separator size.

Return type:	int

See also

SetToolSeparation

---

GetToolShortHelp(self, toolId)

Returns the short help for the given tool.

Parameters:	toolId (int) – ID of the tool in question, as passed to AddTool .
Return type:	string

See also

GetToolLongHelp , SetToolShortHelp

---

GetToolSize(self)

Returns the size of a whole button, which is usually larger than a tool bitmap because of added 3D effects.

Return type:	wx.Size

See also

SetToolBitmapSize , GetToolBitmapSize

---

GetToolState(self, toolId)

Gets the on/off state of a toggle tool.

Parameters:	toolId (int) – ID of the tool in question, as passed to AddTool .
Return type:	bool
Returns:	True if the tool is toggled on, False otherwise.

See also

ToggleTool

---

GetToolsCount(self)

Returns the number of tools in the toolbar.

Return type:	int

---

InsertControl(self, pos, control, label="")

Inserts the control into the toolbar at the given position.

You must call Realize for the change to take place.

Parameters:	pos (int) – control (wx.Control) – label (string) –
Return type:	wx.ToolBarToolBase

See also

AddControl , InsertTool

---

InsertLabelTool(self, pos, id, label, bitmap, bmpDisabled=wx.NullBitmap, kind=wx.ITEM_NORMAL, shortHelp="", longHelp="", clientData=None)

Old style method to insert a tool in the toolbar.

Deprecated since version 3.0.3: Use InsertTool instead.

---

InsertSeparator(self, pos)

Inserts the separator into the toolbar at the given position.

You must call Realize for the change to take place.

Parameters:	pos (int) –
Return type:	wx.ToolBarToolBase

See also

AddSeparator , InsertTool

---

InsertSimpleTool(self, pos, toolId, bitmap, shortHelpString="", longHelpString="", isToggle=0)

Old style method to insert a tool in the toolbar.

Deprecated since version 3.0.3: Use InsertTool instead.

---

InsertStretchableSpace(self, pos)

Inserts a stretchable space at the given position.

See AddStretchableSpace for details about stretchable spaces.

Parameters:	pos (int) –
Return type:	wx.ToolBarToolBase

New in version 2.9.1.

See also

InsertTool , InsertSeparator

---

InsertTool(self, *args, **kw)

Inserts the tool with the specified attributes into the toolbar at the given position.

You must call Realize for the change to take place.

Returns:	The newly inserted tool or None on failure. Notice that with the overload taking tool parameter the caller is responsible for deleting the tool in the latter case.

See also

AddTool , InsertControl , InsertSeparator

 Overloaded Implementations:

---

InsertTool (self, pos, toolId, label, bitmap, bmpDisabled=NullBitmap, kind=ITEM_NORMAL, shortHelp=””, longHelp=””, clientData=None)

Parameters:	pos (int) – toolId (int) – label (string) – bitmap (wx.Bitmap) – bmpDisabled (wx.Bitmap) – kind (ItemKind) – shortHelp (string) – longHelp (string) – clientData (PyUserData) –
Return type:	wx.ToolBarToolBase

---

InsertTool (self, pos, tool)

Parameters:	pos (int) – tool (wx.ToolBarToolBase) –
Return type:	wx.ToolBarToolBase

---

---

Realize(self)

This function should be called after you have added tools.

Return type:	bool

---

RemoveTool(self, id)

Removes the given tool from the toolbar but doesn’t delete it.

This allows to insert/add this tool back to this (or another) toolbar later.

Parameters:	id (int) –
Return type:	wx.ToolBarToolBase

Note

It is unnecessary to call Realize for the change to take place, it will happen immediately.

See also

DeleteTool

---

SetDropdownMenu(self, id, menu)

Sets the dropdown menu for the tool given by its id.

The tool itself will delete the menu when it’s no longer needed. Only supported under GTK+ und MSW.

If you define a EVT_TOOL_DROPDOWN() handler in your program, you must call wx.Event.Skip from it or the menu won’t be displayed.

Parameters:	id (int) – menu (wx.Menu) –
Return type:	bool

---

SetMargins(self, *args, **kw)

 Overloaded Implementations:

---

SetMargins (self, x, y)

Set the values to be used as margins for the toolbar.

Parameters:	x (int) – Left margin, right margin and inter-tool separation value. y (int) – Top margin, bottom margin and inter-tool separation value.

Note

This must be called before the tools are added if absolute positioning is to be used, and the default (zero-size) margins are to be overridden.

See also

GetMargins

---

SetMargins (self, size)

Set the margins for the toolbar.

Parameters:	size (wx.Size) – Margin size.

Note

This must be called before the tools are added if absolute positioning is to be used, and the default (zero-size) margins are to be overridden.

See also

GetMargins , wx.Size

---

---

SetToolBitmapSize(self, size)

Sets the default size of each tool bitmap.

The default bitmap size is 16 by 15 pixels.

Parameters:	size (wx.Size) – The size of the bitmaps in the toolbar.

Note

This should be called to tell the toolbar what the tool bitmap size is. Call it before you add tools.

See also

GetToolBitmapSize , GetToolSize

---

SetToolClientData(self, id, clientData)

Sets the client data associated with the tool.

Parameters:	id (int) – ID of the tool in question, as passed to AddTool . clientData (PyUserData) – The client data to use.

---

SetToolDisabledBitmap(self, id, bitmap)

Sets the bitmap to be used by the tool with the given ID when the tool is in a disabled state.

This can only be used on Button tools, not controls.

Parameters:	id (int) – ID of the tool in question, as passed to AddTool . bitmap (wx.Bitmap) – Bitmap to use for disabled tools.

Note

The native toolbar classes on the main platforms all synthesize the disabled bitmap from the normal bitmap, so this function will have no effect on those platforms.

---

SetToolLongHelp(self, toolId, helpString)

Sets the long help for the given tool.

Parameters:	toolId (int) – ID of the tool in question, as passed to AddTool . helpString (string) – A string for the long help.

Note

You might use the long help for displaying the tool purpose on the status line.

See also

GetToolLongHelp , SetToolShortHelp ,

---

SetToolNormalBitmap(self, id, bitmap)

Sets the bitmap to be used by the tool with the given ID.

This can only be used on Button tools, not controls.

Parameters:	id (int) – ID of the tool in question, as passed to AddTool . bitmap (wx.Bitmap) – Bitmap to use for normals tools.

---

SetToolPacking(self, packing)

Sets the value used for spacing tools.

The default value is 1.

Parameters:	packing (int) – The value for packing.

Note

The packing is used for spacing in the vertical direction if the toolbar is horizontal, and for spacing in the horizontal direction if the toolbar is vertical.

See also

GetToolPacking

---

SetToolSeparation(self, separation)

Sets the default separator size.

The default value is 5.

Parameters:	separation (int) – The separator size.

See also

AddSeparator

---

SetToolShortHelp(self, toolId, helpString)

Sets the short help for the given tool.

Parameters:	toolId (int) – ID of the tool in question, as passed to AddTool . helpString (string) – The string for the short help.

Note

An application might use short help for identifying the tool purpose in a tooltip.

See also

GetToolShortHelp , SetToolLongHelp

---

ToggleTool(self, toolId, toggle)

Toggles a tool on or off.

This does not cause any event to get emitted.

Parameters:	toolId (int) – ID of the tool in question, as passed to AddTool . toggle (bool) – If True, toggles the tool on, otherwise toggles it off.

Note

Only applies to a tool that has been specified as a toggle tool.

Properties

---

Margins

See GetMargins and SetMargins

---

ToolBitmapSize

See GetToolBitmapSize and SetToolBitmapSize

---

ToolPacking

See GetToolPacking and SetToolPacking

---

ToolSeparation

See GetToolSeparation and SetToolSeparation

---

ToolSize

See GetToolSize

---

ToolsCount

See GetToolsCount