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
Class Hierarchy¶
Known Subclasses¶
Methods Summary¶
Constructor. |
|
Create a copy of this wx.aui.AuiDockArt instance. |
|
Draws a background. |
|
Draws a border. |
|
Draws a caption. |
|
Draws a gripper. |
|
Draws a button in the pane’s title bar. |
|
Draws a sash between two windows. |
|
Get the colour of a certain setting. |
|
Get a font setting. |
|
Get the value of a certain setting. |
|
Set a certain setting with the value colour. |
|
Set a font setting. |
|
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:
- DrawBackground(self, dc, window, orientation, rect)¶
Draws a background.
- 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.
- 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:
id (int)
colour (wx.Colour)
- 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.- Parameters:
id (int)
new_val (int)
- Return type:
None