wx.aui.AuiToolBarArt

wx.aui.AuiToolBarArt is part of the AUI class framework and is the base class defining the interface for rendering wx.aui.AuiToolBar.

It is an abstract base class and its concrete AuiGenericToolBarArt and AuiMSWToolBarArt subclasses provide the implementations used by default under all non-MSW platforms and under MSW respectively.

See also wx.aui.AuiToolBar and AUI Overview.

Class Hierarchy

Inheritance diagram for class AuiToolBarArt:

Known Subclasses

wx.aui.AuiDefaultToolBarArt, AuiGenericToolBarArt

Methods Summary

__init__
Clone
DrawBackground
DrawButton
DrawControlLabel
DrawDropDownButton
DrawGripper
DrawLabel
DrawOverflowButton
DrawPlainBackground
DrawSeparator
GetElementSize	Returns the size of the given element in DIPs.
GetElementSizeForWindow	Get the element size scaled by the DPI of the given window.
GetFlags
GetFont
GetLabelSize	Return the size of the label for the given item.
GetTextDirection	Return the direction used for rendering text.
GetTextOrientation
GetToolSize	Return the size of the given item.
SetElementSize	Sets the size of the given element in DIPs.
SetFlags
SetFont
SetTextDirection	Set the text direction for rendering text.
SetTextOrientation
ShowDropDown

Properties Summary

Flags	See GetFlags and SetFlags
Font	See GetFont and SetFont
TextDirection	See GetTextDirection and SetTextDirection
TextOrientation	See GetTextOrientation and SetTextOrientation

Class API

class wx.aui.AuiToolBarArt(object)

Possible constructors:

AuiToolBarArt() -> None

AuiToolBarArt is part of the AUI class framework and is the base class defining the interface for rendering AuiToolBar.

Methods

__init__(self)

Return type:

None

---

Clone(self)

Return type:

wx.aui.AuiToolBarArt

---

DrawBackground(self, dc, wnd, rect)

Parameters:

• dc (wx.DC)

• wnd (wx.Window)

• rect (wx.Rect)

Return type:

None

---

DrawButton(self, dc, wnd, item, rect)

Parameters:

• dc (wx.DC)

• wnd (wx.Window)

• item (wx.aui.AuiToolBarItem)

• rect (wx.Rect)

Return type:

None

---

DrawControlLabel(self, dc, wnd, item, rect)

Parameters:

• dc (wx.DC)

• wnd (wx.Window)

• item (wx.aui.AuiToolBarItem)

• rect (wx.Rect)

Return type:

None

---

DrawDropDownButton(self, dc, wnd, item, rect)

Parameters:

• dc (wx.DC)

• wnd (wx.Window)

• item (wx.aui.AuiToolBarItem)

• rect (wx.Rect)

Return type:

None

---

DrawGripper(self, dc, wnd, rect)

Parameters:

• dc (wx.DC)

• wnd (wx.Window)

• rect (wx.Rect)

Return type:

None

---

DrawLabel(self, dc, wnd, item, rect)

Parameters:

• dc (wx.DC)

• wnd (wx.Window)

• item (wx.aui.AuiToolBarItem)

• rect (wx.Rect)

Return type:

None

---

DrawOverflowButton(self, dc, wnd, rect, state)

Parameters:

• dc (wx.DC)

• wnd (wx.Window)

• rect (wx.Rect)

• state (int)

Return type:

None

---

DrawPlainBackground(self, dc, wnd, rect)

Parameters:

• dc (wx.DC)

• wnd (wx.Window)

• rect (wx.Rect)

Return type:

None

---

DrawSeparator(self, dc, wnd, rect)

Parameters:

• dc (wx.DC)

• wnd (wx.Window)

• rect (wx.Rect)

Return type:

None

---

GetElementSize(self, elementId)

Returns the size of the given element in DIPs.

This function is typically more convenient to override, as it can just return the same value as was passed to SetElementSize , but it shouldn’t usually be called, use GetElementSizeForWindow instead.

Parameters:

elementId (int) – One of wx.aui.AuiToolBarArtSetting elements.

Return type:

int

Returns:

The size of the element in DIPs.

---

GetElementSizeForWindow(self, elementId, window)

Get the element size scaled by the DPI of the given window.

This function should be used to get the size of the element in pixels.

The default version delegates to GetElementSize , override this function if a different behaviour (e.g. to use some smarter algorithm for scaling instead of just multiplying by the DPI factor) is needed.

Parameters:

• elementId (int) – One of wx.aui.AuiToolBarArtSetting elements.

• window (wx.Window) – A valid window, typically wx.aui.AuiToolBar itself.

Return type:

int

Returns:

The size of the element in pixels.

Added in version 4.3/wxWidgets-3.3.0.

See also

SetElementSize

---

GetFlags(self)

Return type:

int

---

GetFont(self)

Return type:

Font

---

GetLabelSize(self, dc, wnd, item)

Return the size of the label for the given item.

Note that the type of dc was wx.DC until wxWidgets 3.3.0, where it was changed to wx.ReadOnlyDC as this function doesn’t modify the DC contents.

Parameters:

• dc (wx.ReadOnlyDC)

• wnd (wx.Window)

• item (wx.aui.AuiToolBarItem)

Return type:

Size

---

GetTextDirection(self)

Return the direction used for rendering text.

Always returns wx.aui.AuiTextDirection.LeftToRight in the base class.

Return type:

wx.aui.AuiTextDirection

Added in version 4.3/wxWidgets-3.3.2.

---

GetTextOrientation(self)

Return type:

int

---

GetToolSize(self, dc, wnd, item)

Return the size of the given item.

Note that the type of dc was wx.DC until wxWidgets 3.3.0, where it was changed to wx.ReadOnlyDC as this function doesn’t modify the DC contents.

Parameters:

• dc (wx.ReadOnlyDC)

• wnd (wx.Window)

• item (wx.aui.AuiToolBarItem)

Return type:

Size

---

SetElementSize(self, elementId, size)

Sets the size of the given element in DIPs.

Note that this function takes the size in DPI-independent pixels and this size will be scaled by the factor depending on the DPI being actually used by GetElementSizeForWindow . In particular, do not use wx.Window.FromDIP for the size argument passed to this function.

Parameters:

• elementId (int) – One of wx.aui.AuiToolBarArtSetting elements.

• size (int) – The size of the element in DIPs.

Return type:

None

---

SetFlags(self, flags)

Parameters:

flags (int)

Return type:

None

---

SetFont(self, font)

Parameters:

font (wx.Font)

Return type:

None

---

SetTextDirection(self, direction)

Set the text direction for rendering text.

Does nothing in the base class, override this function to support vertical text rendering.

Parameters:

direction (AuiTextDirection)

Return type:

None

Added in version 4.3/wxWidgets-3.3.2.

---

SetTextOrientation(self, orientation)

Parameters:

orientation (int)

Return type:

None

---

ShowDropDown(self, wnd, items)

Parameters:

• wnd (wx.Window)

• items (AuiToolBarItemArray)

Return type:

int

Properties

Flags

See GetFlags and SetFlags

---

Font

See GetFont and SetFont

---

TextDirection

See GetTextDirection and SetTextDirection

---

TextOrientation

See GetTextOrientation and SetTextOrientation