wx.aui.AuiDockArt

wx.aui.AuiDockArt is part of the AUI class framework.

See also AUI Overview.

wx.aui.AuiDockArt is the art provider: provides all drawing functionality to the Aui dock manager. This allows the dock manager to have a pluggable look-and-feel.

By default, a wx.aui.AuiManager uses an instance of this class called wx.aui.AuiDefaultDockArt which provides bitmap art and a colour scheme that is adapted to the major platforms’ look. You can either derive from that class to alter its behaviour or write a completely new dock art class. Call wx.aui.AuiManager.SetArtProvider to force AUI to use your new dock art provider.

See also

wx.aui.AuiManager, wx.aui.AuiPaneInfo

Class Hierarchy

Inheritance diagram for class AuiDockArt:

Known Subclasses

wx.aui.AuiDefaultDockArt

Methods Summary

__init__	Constructor.
Clone	Create a copy of this wx.aui.AuiDockArt instance.
DrawBackground	Draws a background.
DrawBorder	Draws a border.
DrawCaption	Draws a caption.
DrawGripper	Draws a gripper.
DrawPaneButton	Draws a button in the pane’s title bar.
DrawSash	Draws a sash between two windows.
GetColour	Get the colour of a certain setting.
GetFont	Get a font setting.
GetMetric	Get the value of a certain setting.
GetMetricForWindow	Get metric value scaled by the DPI of the given window if appropriate.
SetColour	Set a certain setting with the value colour.
SetFont	Set a font setting.
SetMetric	Set a certain setting with the value new_val.

Class API

class wx.aui.AuiDockArt(object)

Possible constructors:

AuiDockArt() -> None

AuiDockArt is part of the AUI class framework.

Methods

__init__(self)

Constructor.

Return type:

None

---

Clone(self)

Create a copy of this wx.aui.AuiDockArt instance.

Return type:

wx.aui.AuiDockArt

---

DrawBackground(self, dc, window, orientation, rect)

Draws a background.

Parameters:

• dc (wx.DC)

• window (wx.Window)

• orientation (int)

• rect (wx.Rect)

Return type:

None

---

DrawBorder(self, dc, window, rect, pane)

Draws a border.

Parameters:

• dc (wx.DC)

• window (wx.Window)

• rect (wx.Rect)

• pane (wx.aui.AuiPaneInfo)

Return type:

None

---

DrawCaption(self, dc, window, text, rect, pane)

Draws a caption.

Parameters:

• dc (wx.DC)

• window (wx.Window)

• text (string)

• rect (wx.Rect)

• pane (wx.aui.AuiPaneInfo)

Return type:

None

---

DrawGripper(self, dc, window, rect, pane)

Draws a gripper.

Parameters:

• dc (wx.DC)

• window (wx.Window)

• rect (wx.Rect)

• pane (wx.aui.AuiPaneInfo)

Return type:

None

---

DrawPaneButton(self, dc, window, button, button_state, rect, pane)

Draws a button in the pane’s title bar.

button can be one of the values of AuiButtonId. button_state can be one of the values of AuiPaneButtonState.

Parameters:

• dc (wx.DC)

• window (wx.Window)

• button (int)

• button_state (int)

• rect (wx.Rect)

• pane (wx.aui.AuiPaneInfo)

Return type:

None

---

DrawSash(self, dc, window, orientation, rect)

Draws a sash between two windows.

Parameters:

• dc (wx.DC)

• window (wx.Window)

• orientation (int)

• rect (wx.Rect)

Return type:

None

---

GetColour(self, id)

Get the colour of a certain setting.

id can be one of the colour values of AuiPaneDockArtSetting.

Parameters:

id (int)

Return type:

Colour

---

GetFont(self, id)

Get a font setting.

Parameters:

id (int)

Return type:

Font

---

GetMetric(self, id)

Get the value of a certain setting.

id can be one of the size values of AuiPaneDockArtSetting.

This function returns the same value that was set by SetMetric , use GetMetricForWindow to get the value appropriate for the given window for metrics that express sizes.

Parameters:

id (int)

Return type:

int

---

GetMetricForWindow(self, id, window)

Get metric value scaled by the DPI of the given window if appropriate.

Call this function instead of GetMetric to get the metric value scaled by the window DPI for the metrics that are expressed in pixels and must be scaled.

The default implementation doesn’t scale AUI_DOCKART_SASH_SIZE and AUI_DOCKART_PANE_BORDER_SIZE metrics in order to allow setting them to just a single pixel (which is the default value for the latter in wx.aui.AuiDefaultDockArt) even in high DPI. You may override this function in your custom art implementation to scale these metrics too if you prefer to have thicker borders in high DPI.

Note that values of AUI_DOCKART_GRADIENT_TYPE are not expressed in pixels and so should never be scaled by this function.

Parameters:

• id (int)

• window (wx.Window)

Return type:

int

Added in version 4.3/wxWidgets-3.3.0.

---

SetColour(self, id, colour)

Set a certain setting with the value colour.

id can be one of the colour values of AuiPaneDockArtSetting.

Parameters:

• id (int)

• colour (wx.Colour)

Return type:

None

---

SetFont(self, id, font)

Set a font setting.

Parameters:

• id (int)

• font (wx.Font)

Return type:

None

---

SetMetric(self, id, new_val)

Set a certain setting with the value new_val.

id can be one of the size values of AuiPaneDockArtSetting.

The interpretation of new_val depends on the metric being set, see GetMetricForWindow .

Parameters:

• id (int)

• new_val (int)

Return type:

None