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


class_hierarchy Class Hierarchy

Inheritance diagram for class AuiDockArt:

sub_classes Known Subclasses

wx.aui.AuiDefaultDockArt


method_summary 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.

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() -> 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: DC, window: Window, orientation: int, rect: Rect)

Draws a background.

Parameters:
Return type:

None



DrawBorder(self, dc: DC, window: Window, rect: Rect, pane: AuiPaneInfo)

Draws a border.

Parameters:
Return type:

None



DrawCaption(self, dc: DC, window: Window, text: str, rect: Rect, pane: AuiPaneInfo)

Draws a caption.

Parameters:
Return type:

None



DrawGripper(self, dc: DC, window: Window, rect: Rect, pane: AuiPaneInfo)

Draws a gripper.

Parameters:
Return type:

None



DrawPaneButton(self, dc: DC, window: Window, button: int, button_state: int, rect: Rect, pane: AuiPaneInfo)

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:
Return type:

None



DrawSash(self, dc: DC, window: Window, orientation: int, rect: Rect)

Draws a sash between two windows.

Parameters:
Return type:

None



GetColour(self, id: int)

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: int)

Get a font setting.

Parameters:

id (int)

Return type:

Font



GetMetric(self, id: int)

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: int, colour: Colour)

Set a certain setting with the value colour.

id can be one of the colour values of AuiPaneDockArtSetting.

Parameters:
Return type:

None



SetFont(self, id: int, font: Font)

Set a font setting.

Parameters:
Return type:

None



SetMetric(self, id: int, new_val: int)

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)

Return type:

None