wx.ToolBarToolBase¶

A toolbar tool represents one item on the toolbar.

It has a unique id (except for the separators), the style (telling whether it is a normal button, separator or a control), the state (toggled or not, enabled or not) and short and long help strings. The default implementations use the short help string for the tooltip text which is popped up when the mouse pointer enters the tool and the long help string for the applications status bar.

Notice that the toolbar can not be modified by changing its tools via the (intentionally undocumented here) setter methods of this class, all the modifications must be done using the methods of wx.ToolBar itself.

Class Hierarchy¶

Inheritance diagram for class ToolBarToolBase:

Methods Summary¶

`__init__`
`Attach`
`CanBeToggled`
`Detach`
`Enable`
`GetBitmap`
`GetClientData`
`GetControl`
`GetDisabledBitmap`
`GetDisabledBitmapBundle`	Return the bundle containing disabled tool bitmaps.
`GetDropdownMenu`
`GetId`
`GetKind`
`GetLabel`
`GetLongHelp`
`GetNormalBitmap`
`GetNormalBitmapBundle`	Return the bundle containing normal tool bitmaps.
`GetShortHelp`
`GetStyle`
`GetToolBar`	Return the toolbar this tool is a member of.
`IsButton`
`IsControl`
`IsEnabled`
`IsSeparator`
`IsStretchable`
`IsStretchableSpace`
`IsToggled`
`MakeStretchable`
`SetClientData`
`SetDisabledBitmap`
`SetDropdownMenu`
`SetLabel`
`SetLongHelp`
`SetNormalBitmap`
`SetShortHelp`
`SetToggle`
`Toggle`

Properties Summary¶

`Bitmap`	See `GetBitmap`
`ClientData`	See `GetClientData` and `SetClientData`
`Control`	See `GetControl`
`DisabledBitmap`	See `GetDisabledBitmap` and `SetDisabledBitmap`
`DisabledBitmapBundle`	See `GetDisabledBitmapBundle`
`DropdownMenu`	See `GetDropdownMenu` and `SetDropdownMenu`
`Id`	See `GetId`
`Kind`	See `GetKind`
`Label`	See `GetLabel` and `SetLabel`
`LongHelp`	See `GetLongHelp` and `SetLongHelp`
`NormalBitmap`	See `GetNormalBitmap` and `SetNormalBitmap`
`NormalBitmapBundle`	See `GetNormalBitmapBundle`
`ShortHelp`	See `GetShortHelp` and `SetShortHelp`
`Style`	See `GetStyle`
`ToolBar`	See `GetToolBar`

Class API¶

class wx.ToolBarToolBase(Object)¶

Possible constructors:

ToolBarToolBase(tbar: Optional[ToolBar]=None, toolid: int=ID_SEPARATOR,
                label: str='', bmpNormal: BitmapBundle=NullBitmap, bmpDisabled:
                BitmapBundle=NullBitmap, kind: ItemKind=ITEM_NORMAL, clientData:
                Optional[PyUserData]=None, shortHelpString: str='', longHelpString:
                str='') -> None

ToolBarToolBase(tbar : ToolBar, control : Control, label : str) -> None

A toolbar tool represents one item on the toolbar.

Methods¶

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

Overloaded Implementations:

__init__ (self, tbar: Optional[ToolBar]=None, toolid: int=ID_SEPARATOR, label: str=’’, bmpNormal: BitmapBundle=NullBitmap, bmpDisabled: BitmapBundle=NullBitmap, kind: ItemKind=ITEM_NORMAL, clientData: Optional[PyUserData]=None, shortHelpString: str=’’, longHelpString: str=’’)

Parameters:

tbar (wx.ToolBar)
toolid (int)
label (string)
bmpNormal (wx.BitmapBundle)
bmpDisabled (wx.BitmapBundle)
kind (ItemKind)
clientData (PyUserData)
shortHelpString (string)
longHelpString (string)

Return type:

None

__init__ (self, tbar : ToolBar, control : Control, label : str)

Parameters:

tbar (wx.ToolBar)
control (wx.Control)
label (string)

Return type:

None

Attach(self, tbar: ToolBar)¶

Parameters:: tbar (wx.ToolBar)
Return type:: None

CanBeToggled(self)¶

Return type:: bool

Detach(self)¶

Return type:: None

Enable(self, enable: bool)¶

Parameters:: enable (bool)
Return type:: bool

GetBitmap(self)¶

Return type:: wx.Bitmap

GetClientData(self)¶

Return type:: PyUserData

GetControl(self)¶

Return type:: wx.Control

GetDisabledBitmap(self)¶

Return type:: wx.Bitmap

GetDisabledBitmapBundle(self)¶

Return the bundle containing disabled tool bitmaps.

This bundle may be invalid if the tool doesn’t show a bitmap or doesn’t have a specific disabled bitmap creates one automatically from the normal bitmap.