Inheritance diagram for AuiToolBarItem:
AuiToolBarItem is a toolbar element. 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.
Bases: object
AuiToolBarItem is a toolbar element. 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.
Default class constructor.
Parameter: | item – another instance of L{AuiToolBarItem}. |
---|
Assigns the properties of the L{AuiToolBarItem} c to self.
Parameter: | c – another instance of L{AuiToolBarItem}. |
---|
Activates/deactivates the toolbar item.
Parameter: | b – True to activate the item, False to deactivate it. |
---|
Sets the toolbar item alignment.
Parameter: | l – the item alignment, which can be one of the available wx.Sizer alignments. |
---|
Sets the toolbar item bitmap.
Parameter: | bmp – an instance of wx.Bitmap. |
---|
Sets the toolbar item disabled bitmap.
Parameter: | bmp – an instance of wx.Bitmap. |
---|
Sets whether the toolbar item has an associated dropdown menu.
Parameter: | b – True to set a dropdown menu, False otherwise. |
---|
Sets the toolbar item hover bitmap.
Parameter: | bmp – an instance of wx.Bitmap. |
---|
Sets the toolbar item identifier.
Parameter: | new_id – the new tool id. |
---|
Sets the L{AuiToolBarItem} kind.
Parameter: | kind – can be one of the following item: |
---|
Item Kind | Description |
---|---|
ITEM_CONTROL | The item in the AuiToolBar is a control |
ITEM_LABEL | The item in the AuiToolBar is a text label |
ITEM_SPACER | The item in the AuiToolBar is a spacer |
ITEM_SEPARATOR | The item in the AuiToolBar is a separator |
ITEM_CHECK | The item in the AuiToolBar is a toolbar check item |
ITEM_NORMAL | The item in the AuiToolBar is a standard toolbar item |
ITEM_RADIO | The item in the AuiToolBar is a toolbar radio item |
Sets the toolbar item label.
Parameter: | s – a string specifying the toolbar item label. |
---|
Sets the long help string for the toolbar item. This string is shown in the statusbar (if any) of the parent frame when the mouse pointer is inside the tool.
Parameter: | s – the tool long help string. |
---|
Sets the toolbar item minimum size.
Parameter: | s – an instance of wx.Size. |
---|
Sets the L{AuiToolBarItem} proportion in the toolbar.
Parameter: | p – the item proportion. |
---|
Sets the short help string for the L{AuiToolBarItem}, to be displayed in a wx.ToolTip when the mouse hover over the toolbar item.
Parameter: | s – the tool short help string. |
---|
Associates a sizer item to this toolbar item.
Parameter: | s – an instance of wx.SizerItem. |
---|
Sets the number of pixels for a toolbar item with kind=``ITEM_SEPARATOR``.
Parameter: | s – number of pixels. |
---|
Sets the toolbar item state.
Parameter: | state – can be one of the following states: |
---|
Button State Constant | Description |
---|---|
AUI_BUTTON_STATE_NORMAL | Normal button state |
AUI_BUTTON_STATE_HOVER | Hovered button state |
AUI_BUTTON_STATE_PRESSED | Pressed button state |
AUI_BUTTON_STATE_DISABLED | Disabled button state |
AUI_BUTTON_STATE_HIDDEN | Hidden button state |
AUI_BUTTON_STATE_CHECKED | Checked button state |
Sets whether the toolbar item is sticky (permanent highlight after mouse enter) or not.
Parameter: | b – True to set the item as sticky, False otherwise. |
---|
Associates some kind of user data to the toolbar item. The user data can be any Python object.
Parameter: | l – a Python object. |
---|
Assigns a window to the toolbar item.
Parameter: | w – an instance of wx.Window. |
---|