wx.aui.AuiToolBar is a dockable toolbar, part of the AUI
class framework.
See also AUI Overview.
The appearance of this class is configurable and can be changed by calling wx.aui.AuiToolBar.SetArtProvider
. By default, native art provider is used if available (currently only in wxMSW) and AuiGenericToolBarArt otherwise.
This class supports the following styles:
wx.aui.AUI_TB_TEXT
: Display the label strings on the toolbar buttons.
wx.aui.AUI_TB_NO_TOOLTIPS
: Do not show tooltips for the toolbar items.
wx.aui.AUI_TB_NO_AUTORESIZE
: Do not automatically resize the toolbar when new tools are added.
wx.aui.AUI_TB_GRIPPER
: Show the toolbar’s gripper control. If the toolbar is added to an AUI
pane that contains a gripper, this style will be automatically set.
wx.aui.AUI_TB_OVERFLOW
: Show an overflow menu containing toolbar items that can’t fit on the toolbar if it is too small.
wx.aui.AUI_TB_VERTICAL
: Using this style forces the toolbar to be vertical and be only dockable to the left or right sides of the window whereas by default it can be horizontal or vertical and be docked anywhere.
wx.aui.AUI_TB_HORZ_LAYOUT
:
wx.aui.AUI_TB_HORIZONTAL
: Analogous to wx.aui.AUI_TB_VERTICAL
, but forces the toolbar to be horizontal.
wx.aui.AUI_TB_PLAIN_BACKGROUND
: Draw a plain background (based on parent) instead of the default gradient background.
wx.aui.AUI_TB_HORZ_TEXT
: Equivalent to wx.aui.AUI_TB_HORZ_LAYOUT
| wx.aui.AUI_TB_TEXT
wx.aui.AUI_TB_DEFAULT_STYLE
: The default is to have no styles.
Handlers bound for the following event types will receive a wx.aui.AuiToolBarEvent parameter.
EVT_AUITOOLBAR_TOOL_DROPDOWN: Process a wxEVT_AUITOOLBAR_TOOL_DROPDOWN event
EVT_AUITOOLBAR_OVERFLOW_CLICK: Process a wxEVT_AUITOOLBAR_OVERFLOW_CLICK event
EVT_AUITOOLBAR_RIGHT_CLICK: Process a wxEVT_AUITOOLBAR_RIGHT_CLICK event
EVT_AUITOOLBAR_MIDDLE_CLICK: Process a wxEVT_AUITOOLBAR_MIDDLE_CLICK event
EVT_AUITOOLBAR_BEGIN_DRAG: Process a wxEVT_AUITOOLBAR_BEGIN_DRAG event
Default constructor, use |
|
Really create wx.aui.AuiToolBar created using default constructor. |
|
Removes the tool at the given position from the toolbar. |
|
Removes the tool with the given |
|
Destroys the tool with the given |
|
Destroys the tool at the given position and its associated window, if any. |
|
get size of hint rectangle for a particular dock location |
|
Returns whether the specified toolbar item has an associated drop down button. |
|
Gets the window style that was passed to the constructor or |
|
Add toolbar items that are always displayed in the overflow menu. |
|
Sets the font for this window. |
|
Set whether the specified toolbar item has a drop down button. |
|
Sets the style of the window. |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
Possible constructors:
AuiToolBar() -> None
AuiToolBar(parent : Window, id: int=ID_ANY, position:
Point=DefaultPosition, size: Size=DefaultSize, style:
int=AUI_TB_DEFAULT_STYLE) -> None
AuiToolBar is a dockable toolbar, part of the AUI
class framework.
__init__ (self)
Default constructor, use Create
later.
None
Added in version 2.9.5.
__init__ (self, parent : Window, id: int=ID_ANY, position: Point=DefaultPosition, size: Size=DefaultSize, style: int=AUI_TB_DEFAULT_STYLE)
Constructor creating and initializing the object.
None
control (wx.Control)
label (string)
toolId (int)
label (string)
width (int)
pixels (int)
proportion (int)
AddTool (self, toolId : int, label : str, bitmap : BitmapBundle, short_help_string: str=’’, kind: ItemKind=ITEM_NORMAL)
toolId (int)
label (string)
bitmap (wx.BitmapBundle)
short_help_string (string)
kind (ItemKind)
AddTool (self, toolId : int, label : str, bitmap : BitmapBundle, disabled_bitmap : BitmapBundle, kind : ItemKind, short_help_string : str, long_help_string : str, client_data : Object)
toolId (int)
label (string)
bitmap (wx.BitmapBundle)
disabled_bitmap (wx.BitmapBundle)
kind (ItemKind)
short_help_string (string)
long_help_string (string)
client_data (wx.Object)
AddTool (self, toolId : int, bitmap : BitmapBundle, disabled_bitmap : BitmapBundle, toggle: bool=False, client_data: Optional[Object]=None, short_help_string: str=’’, long_help_string: str=’’)
toolId (int)
bitmap (wx.BitmapBundle)
disabled_bitmap (wx.BitmapBundle)
toggle (bool)
client_data (wx.Object)
short_help_string (string)
long_help_string (string)
None
None
Really create wx.aui.AuiToolBar created using default constructor.
bool
Added in version 2.9.5.
Removes the tool at the given position from the toolbar.
Note that if this tool was added by AddControl
, the associated control is not deleted and must either be reused (e.g. by reparenting it under a different window) or destroyed by caller. If this behaviour is unwanted, prefer using DestroyToolByIndex
instead.
idx (int) – The index, or position, of a previously added tool.
bool
True
if the tool was removed or False
otherwise, e.g. if the provided index is out of range.
Removes the tool with the given ID
from the toolbar.
Note that if this tool was added by AddControl
, the associated control is not deleted and must either be reused (e.g. by reparenting it under a different window) or destroyed by caller. If this behaviour is unwanted, prefer using DestroyTool
instead.
toolId (int) – ID
of a previously added tool.
bool
True
if the tool was removed or False
otherwise, e.g. if the tool with the given ID
was not found.
Destroys the tool with the given ID
and its associated window, if any.
toolId (int) – ID
of a previously added tool.
bool
True
if the tool was destroyed or False
otherwise, e.g. if the tool with the given ID
was not found.
Added in version 4.1/wxWidgets-3.1.4.
Destroys the tool at the given position and its associated window, if any.
idx (int) – The index, or position, of a previously added tool.
bool
True
if the tool was destroyed or False
otherwise, e.g. if the provided index is out of range.
toolId (int)
state (bool)
None
window_id (int)
Control
toolId (int)
idx (int)
x (int)
y (int)
variant (WindowVariant)
VisualAttributes
bool
get size of hint rectangle for a particular dock location
dock_direction (int)
Size
bool
bool
toolId (int)
Bitmap
Size
int
int
Returns whether the specified toolbar item has an associated drop down button.
toolId (int)
bool
See also
toolId (int)
bool
toolId (int)
bool
toolId (int)
bool
toolId (int)
int
toolId (int)
str
toolId (int)
str
int
toolId (int)
int
toolId (int)
int
toolId (int)
Rect
int
toolId (int)
str
toolId (int)
bool
int
toolId (int)
bool
Gets the window style that was passed to the constructor or Create
method.
GetWindowStyle
is another name for the same function.
int
pane (wx.aui.AuiPaneInfo)
bool
bool
art (wx.aui.AuiToolBarArt)
None
Add toolbar items that are always displayed in the overflow menu.
If there are custom items set, then the overflow menu will be displayed even if there are no items from the main toolbar that overflow.
prepend (AuiToolBarItemArray) – are the items to show before any overflow items
append (AuiToolBarItemArray) – are the items to show after any overflow items
None
Note
The toolbar must have the AUI_TB_OVERFLOW
style.
Sets the font for this window.
This function should not be called for the parent window if you don’t want its font to be inherited by its children, use SetOwnFont
instead in this case and see InheritAttributes
for more explanations.
Please notice that the given font is not automatically used for wx.PaintDC objects associated with this window, you need to call wx.DC.SetFont
too. However this font is used by any standard controls for drawing their text as well as by GetTextExtent
.
font (wx.Font) – Font to associate with this window, pass NullFont to reset to the default font.
bool
True
if the font was really changed, False
if it was already set to this font and nothing was done.
See also
GetFont
, InheritAttributes
visible (bool)
None
SetMargins (self, size : Size)
size (wx.Size)
None
SetMargins (self, x : int, y : int)
x (int)
y (int)
None
SetMargins (self, left : int, right : int, top : int, bottom : int)
left (int)
right (int)
top (int)
bottom (int)
None
visible (bool)
None
toolId (int)
bitmap (wx.BitmapBundle)
None
padding (int)
None
Set whether the specified toolbar item has a drop down button.
This is only valid for wx.ITEM_NORMAL
tools.
toolId (int)
dropdown (bool)
None
See also
toolId (int)
label (string)
None
toolId (int)
help_string (string)
None
packing (int)
None
toolId (int)
proportion (int)
None
separation (int)
None
toolId (int)
help_string (string)
None
toolId (int)
sticky (bool)
None
orientation (int)
None
Sets the style of the window.
Please note that some styles cannot be changed after the window creation and that Refresh
might need to be called after changing the others for the change to take place immediately.
See Window styles for more information about flags.
style (long)
None
See also
toolId (int)
state (bool)
None
See GetArtProvider
and SetArtProvider
See GetGripperVisible
and SetGripperVisible
See GetOverflowVisible
and SetOverflowVisible
See GetToolBarFits
See GetToolBitmapSize
and SetToolBitmapSize
See GetToolCount
See GetToolPacking
and SetToolPacking
See GetToolSeparation
and SetToolSeparation
See GetWindowStyleFlag
and SetWindowStyleFlag