Phoenix Logo

phoenix_title 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 plugable 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.


class_hierarchy Class Hierarchy

Inheritance diagram for class AuiDockArt:


sub_classes Known Subclasses

wx.aui.AuiDefaultDockArt


method_summary Methods Summary

__init__ Constructor.
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.
SetColour Set a certain setting with the value colour.
SetFont Set a font setting.
SetMetric Set a certain setting with the value new_val.

api Class API



class wx.aui.AuiDockArt(object)

Possible constructors:

AuiDockArt()

AuiDockArt is part of the AUI class framework.


Methods



__init__(self)

Constructor.



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

Draws a background.

Parameters:


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

Draws a border.

Parameters:


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

Draws a caption.

Parameters:


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

Draws a gripper.

Parameters:


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:


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

Draws a sash between two windows.

Parameters:


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.

Parameters:id (int) –
Return type:int


SetColour(self, id, colour)

Set a certain setting with the value colour.

id can be one of the colour values of AuiPaneDockArtSetting.

Parameters:


SetFont(self, id, font)

Set a font setting.

Parameters:


SetMetric(self, id, new_val)

Set a certain setting with the value new_val.

id can be one of the size values of AuiPaneDockArtSetting.

Parameters:
  • id (int) –
  • new_val (int) –