wx.aui.AuiDockArt

Inheritance diagram for wx.aui.AuiDockArt:

Description

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

Dock art provider code – a dock provider provides all drawing functionality to the wxAUI dock manager. This allows the dock manager to have a plugable look-and-feel.

By default, a wx.aui.AuiManager uses an instance of this class called wx.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 make use this new dock art.

See also

wx.aui.AuiPaneInfo, wx.aui.AuiManager

Constants

Flags than can be used in methods SetColor, SetColour, SetFont, SetMetric and relative getters (coming from a structure called wxAuiPaneDockArtSetting):

Flags	Value
wx.aui.AUI_DOCKART_SASH_SIZE	0
wx.aui.AUI_DOCKART_CAPTION_SIZE	1
wx.aui.AUI_DOCKART_GRIPPER_SIZE	2
wx.aui.AUI_DOCKART_PANE_BORDER_SIZE	3
wx.aui.AUI_DOCKART_PANE_BUTTON_SIZE	4
wx.aui.AUI_DOCKART_BACKGROUND_COLOUR	5
wx.aui.AUI_DOCKART_SASH_COLOUR	6
wx.aui.AUI_DOCKART_ACTIVE_CAPTION_COLOUR	7
wx.aui.AUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR	8
wx.aui.AUI_DOCKART_INACTIVE_CAPTION_COLOUR	9
wx.aui.AUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR	10
wx.aui.AUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR	11
wx.aui.AUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR	12
wx.aui.AUI_DOCKART_BORDER_COLOUR	13
wx.aui.AUI_DOCKART_GRIPPER_COLOUR	14
wx.aui.AUI_DOCKART_CAPTION_FONT	15
wx.aui.AUI_DOCKART_GRADIENT_TYPE	16

Flags than can be used in method SetMetric and relative getter (coming from a structure called wxAuiPaneDockArtGradients):

Flags	Value
wx.aui.AUI_GRADIENT_NONE	0
wx.aui.AUI_GRADIENT_VERTICAL	1
wx.aui.AUI_GRADIENT_HORIZONTAL	2

Flags than can be used in method DrawPaneButton (coming from a structure called wxAuiPaneButtonState):

Flags	Value
wx.aui.AUI_BUTTON_STATE_NORMAL	0
wx.aui.AUI_BUTTON_STATE_HOVER	1
wx.aui.AUI_BUTTON_STATE_PRESSED	2

Flags than can be used in method DrawPaneButton (coming from a structure called wxAuiButtonId):

Flags	Value
wx.aui.AUI_BUTTON_CLOSE	101
wx.aui.AUI_BUTTON_MAXIMIZE_RESTORE	102
wx.aui.AUI_BUTTON_MINIMIZE	103
wx.aui.AUI_BUTTON_PIN	104
wx.aui.AUI_BUTTON_OPTIONS	105
wx.aui.AUI_BUTTON_WINDOWLIST	106
wx.aui.AUI_BUTTON_LEFT	107
wx.aui.AUI_BUTTON_RIGHT	108
wx.aui.AUI_BUTTON_UP	109
wx.aui.AUI_BUTTON_DOWN	110
wx.aui.AUI_BUTTON_CUSTOM1	201
wx.aui.AUI_BUTTON_CUSTOM2	202
wx.aui.AUI_BUTTON_CUSTOM3	203

Known Subclasses

wx.aui.AuiDefaultDockArt, wx.aui.PyAuiDockArt

Methods Summary

• __init__
• DrawBackground
• DrawBorder
• DrawCaption
• DrawGripper
• DrawPaneButton
• DrawSash
• GetColor
• GetColour
• GetFont
• GetMetric
• SetColor
• SetColour
• SetFont
• SetMetric

Class API

Methods

__init__()

No docstrings available for this method.

---

DrawBackground(dc, window, orientation, rect)

Draws a background.

Parameters:

• dc (wx.DC)
• window (wx.Window)
• orientation (int)
• rect (wx.Rect)

---

DrawBorder(dc, window, rect, pane)

Draws a border.

Parameters:

• dc (wx.DC)
• window (wx.Window)
• rect (wx.Rect)
• pane (wx.aui.AuiPaneInfo)

---

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

Draws a caption.

Parameters:

• dc (wx.DC)
• window (wx.Window)
• text (string)
• rect (wx.Rect)
• pane (wx.aui.AuiPaneInfo)

---

DrawGripper(dc, window, rect, pane)

Draws a gripper.

Parameters:

• dc (wx.DC)
• window (wx.Window)
• rect (wx.Rect)
• pane (wx.aui.AuiPaneInfo)

---

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

Draws a button in the pane’s title bar.

Parameters:

• dc (wx.DC)
• window (wx.Window)
• button (int): can be one of the values of wx.AuiButtonId.
• button_state (int): can be one of the values of wx.AuiPaneButtonState.
• rect (wx.Rect)
• pane (wx.aui.AuiPaneInfo)

---

DrawSash(dc, window, orientation, rect)

Draws a sash between two windows.

Parameters:

• dc (wx.DC)
• window (wx.Window)
• orientation (int)
• rect (wx.Rect)

---

GetColor(id)

The same as GetColour.

Parameters:

• id (int): one of the id values of wx.AuiPaneDockArtSetting.

Returns:

wx.Colour

---

GetColour(id)

Get the colour of a certain setting.

Parameters:

• id (int): one of the id values of wx.AuiPaneDockArtSetting.

Returns:

wx.Colour

---

GetFont(id)

Get a font setting.

Parameters:

• id (int)

Returns:

wx.Font

---

GetMetric(id)

Get the value of a certain setting.

Parameters:

• id (int): one of the id values of wx.AuiPaneDockArtSetting.

Returns:

int

---

SetColor(id, color)

The same as SetColour.

Parameters:

• id (int): one of the id values of wx.AuiPaneDockArtSetting.
• color (wx.Colour)

---

SetColour(id, colour)

Set a certain setting with the value colour.

Parameters:

• id (int): one of the id values of wx.AuiPaneDockArtSetting.
• colour (wx.Colour)

---

SetFont(id, font)

Set a font setting.

Parameters:

• id (int)
• font (wx.Font)

---

SetMetric(id, new_val)

Set a certain setting with the value new_val.

Parameters:

• id (int): can be one of the size values of wx.AuiPaneDockArtSetting.
• new_val (int)