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¶Default Constructor. |
|
Assigns the properties of the wx.aui.AuiToolBarItem “c” to this. |
|
Returns whether the toolbar item can be toggled. |
|
Returns the toolbar item identifier. |
|
Returns the toolbar item kind. |
|
Gets the current state of the toolbar item. |
|
Returns the Window associated to the toolbar item. |
|
Returns whether the toolbar item has an associated drop down button. |
|
Set whether this tool has a drop down button. |
|
Sets the toolbar item identifier. |
|
Sets the wx.aui.AuiToolBarItem kind. |
|
Set the current state of the toolbar item. |
|
Assigns a window to the toolbar item. |
Properties Summary¶See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
Class API¶wx.aui.AuiToolBarItem(object)¶Possible constructors:
AuiToolBarItem()
AuiToolBarItem(c)
AuiToolBarItem is part of the AUI class framework, representing a
toolbar element.
__init__(self, *args, **kw)¶__init__ (self)
Default Constructor.
__init__ (self, c)
Assigns the properties of the wx.aui.AuiToolBarItem “c” to this.
c (wx.aui.AuiToolBarItem) –
Assign(self, c)¶Assigns the properties of the wx.aui.AuiToolBarItem “c” to this.
c (wx.aui.AuiToolBarItem) –
CanBeToggled(self)¶Returns whether the toolbar item can be toggled.
bool
New in version 4.1/wxWidgets-3.1.5.
GetAlignment(self)¶int
GetId(self)¶Returns the toolbar item identifier.
int
GetKind(self)¶Returns the toolbar item kind.
int
one of ITEM_NORMAL , ITEM_CHECK or ITEM_RADIO , ITEM_SEPARATOR , ITEM_CONTROL , ITEM_SPACER , ITEM_LABEL ,
GetLabel(self)¶string
GetLongHelp(self)¶string
GetMinSize(self)¶Size
GetProportion(self)¶int
GetShortHelp(self)¶string
GetSpacerPixels(self)¶int
GetState(self)¶Gets the current state of the toolbar item.
int
an or’d combination of flags from AuiPaneButtonState representing the current state
GetUserData(self)¶long
HasDropDown(self)¶Returns whether the toolbar item has an associated drop down button.
bool
IsActive(self)¶bool
IsSticky(self)¶bool
SetActive(self, b)¶b (bool) –
SetAlignment(self, l)¶l (int) –
SetBitmap(self, bmp)¶bmp (wx.BitmapBundle) –
SetDisabledBitmap(self, bmp)¶bmp (wx.BitmapBundle) –
SetHasDropDown(self, b)¶Set whether this tool has a drop down button.
This is only valid for wx.ITEM_NORMAL tools.
b (bool) –
SetHoverBitmap(self, bmp)¶bmp (wx.BitmapBundle) –
SetId(self, new_id)¶Sets the toolbar item identifier.
new_id (int) –
SetKind(self, new_kind)¶Sets the wx.aui.AuiToolBarItem kind.
new_kind (int) –
SetLabel(self, s)¶s (string) –
SetLongHelp(self, s)¶s (string) –
SetProportion(self, p)¶p (int) –
SetShortHelp(self, s)¶s (string) –
SetSizerItem(self, s)¶s (wx.SizerItem) –
SetSpacerPixels(self, s)¶s (int) –
SetState(self, new_state)¶Set the current state of the toolbar item.
new_state (int) – is an or’d combination of flags from AuiPaneButtonState
SetSticky(self, b)¶b (bool) –
SetUserData(self, l)¶l (long) –
Alignment¶See GetAlignment and SetAlignment
DisabledBitmap¶See GetDisabledBitmap and SetDisabledBitmap
HoverBitmap¶See GetHoverBitmap and SetHoverBitmap
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
UserData¶See GetUserData and SetUserData