wx.aui.AuiToolBarItem¶

wx.aui.AuiToolBarItem is part of the AUI class framework, representing a toolbar element.

See also wx.aui.AuiToolBar and AUI Overview.

It has a unique id (except for the separators which always have id = -1), 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 (currently not implemented).

Class Hierarchy¶

Inheritance diagram for class AuiToolBarItem:

Methods Summary¶

`__init__`	Default Constructor.
`Assign`	Assigns the properties of the wx.aui.AuiToolBarItem “c” to this.
`CanBeToggled`	Returns whether the toolbar item can be toggled.
`GetAlignment`
`GetBitmap`
`GetDisabledBitmap`
`GetHoverBitmap`
`GetId`	Returns the toolbar item identifier.
`GetKind`	Returns the toolbar item kind.
`GetLabel`
`GetLongHelp`
`GetMinSize`
`GetProportion`
`GetShortHelp`
`GetSizerItem`
`GetSpacerPixels`
`GetState`	Gets the current state of the toolbar item.
`GetUserData`
`GetWindow`	Returns the Window associated to the toolbar item.
`HasDropDown`	Returns whether the toolbar item has an associated drop down button.
`IsActive`
`IsSticky`
`SetActive`
`SetAlignment`
`SetBitmap`
`SetDisabledBitmap`
`SetHasDropDown`	Set whether this tool has a drop down button.
`SetHoverBitmap`
`SetId`	Sets the toolbar item identifier.
`SetKind`	Sets the wx.aui.AuiToolBarItem kind.
`SetLabel`
`SetLongHelp`
`SetMinSize`
`SetProportion`
`SetShortHelp`
`SetSizerItem`
`SetSpacerPixels`
`SetState`	Set the current state of the toolbar item.
`SetSticky`
`SetUserData`
`SetWindow`	Assigns a window to the toolbar item.

Properties Summary¶

`Alignment`	See `GetAlignment` and `SetAlignment`
`Bitmap`	See `GetBitmap` and `SetBitmap`
`DisabledBitmap`	See `GetDisabledBitmap` and `SetDisabledBitmap`
`HoverBitmap`	See `GetHoverBitmap` and `SetHoverBitmap`
`Id`	See `GetId` and `SetId`
`Kind`	See `GetKind` and `SetKind`
`Label`	See `GetLabel` and `SetLabel`
`LongHelp`	See `GetLongHelp` and `SetLongHelp`
`MinSize`	See `GetMinSize` and `SetMinSize`
`Proportion`	See `GetProportion` and `SetProportion`
`ShortHelp`	See `GetShortHelp` and `SetShortHelp`
`SizerItem`	See `GetSizerItem` and `SetSizerItem`
`SpacerPixels`	See `GetSpacerPixels` and `SetSpacerPixels`
`State`	See `GetState` and `SetState`
`UserData`	See `GetUserData` and `SetUserData`
`Window`	See `GetWindow` and `SetWindow`

Class API¶

class wx.aui.AuiToolBarItem(object)¶

Possible constructors:

AuiToolBarItem() -> None

AuiToolBarItem(c : AuiToolBarItem) -> None

AuiToolBarItem is part of the AUI class framework, representing a toolbar element.

Methods¶

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

Overloaded Implementations:

__init__ (self)

Default Constructor.

Return type:: None

__init__ (self, c : AuiToolBarItem)

Assigns the properties of the wx.aui.AuiToolBarItem “c” to this.

Parameters:: c (wx.aui.AuiToolBarItem)
Return type:: None

Assign(self, c: AuiToolBarItem)¶

Assigns the properties of the wx.aui.AuiToolBarItem “c” to this.

Parameters:: c (wx.aui.AuiToolBarItem)
Return type:: None

CanBeToggled(self)¶

Returns whether the toolbar item can be toggled.

Return type:: bool

Added in version 4.1/wxWidgets-3.1.5.

GetAlignment(self)¶

Return type:: int

GetBitmap(self)¶

Return type:: Bitmap

GetDisabledBitmap(self)¶

Return type:: Bitmap

GetHoverBitmap(self)¶

Return type:: Bitmap

GetId(self)¶

Returns the toolbar item identifier.

Return type:: int

GetKind(self)¶

Returns the toolbar item kind.

Return type:: int
Returns:: one of ITEM_NORMAL , ITEM_CHECK or ITEM_RADIO , ITEM_SEPARATOR , ITEM_CONTROL , ITEM_SPACER , ITEM_LABEL ,