wx.lib.agw.aui.dockart.AuiDefaultDockArt¶

Dock art provider code - a dock 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 AuiManager uses an instance of this class called 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 AuiManager.SetArtProvider() to make use this new dock art.

Metric Ordinals

These are the possible pane dock art settings for AuiDefaultDockArt:

Metric Ordinal Constant	Description
`AUI_DOCKART_SASH_SIZE`	Customizes the sash size
`AUI_DOCKART_CAPTION_SIZE`	Customizes the caption size
`AUI_DOCKART_GRIPPER_SIZE`	Customizes the gripper size
`AUI_DOCKART_PANE_BORDER_SIZE`	Customizes the pane border size
`AUI_DOCKART_PANE_BUTTON_SIZE`	Customizes the pane button size
`AUI_DOCKART_BACKGROUND_COLOUR`	Customizes the background colour
`AUI_DOCKART_BACKGROUND_GRADIENT_COLOUR`	Customizes the background gradient colour
`AUI_DOCKART_SASH_COLOUR`	Customizes the sash colour
`AUI_DOCKART_ACTIVE_CAPTION_COLOUR`	Customizes the active caption colour
`AUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR`	Customizes the active caption gradient colour
`AUI_DOCKART_INACTIVE_CAPTION_COLOUR`	Customizes the inactive caption colour
`AUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR`	Customizes the inactive gradient caption colour
`AUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR`	Customizes the active caption text colour
`AUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR`	Customizes the inactive caption text colour
`AUI_DOCKART_BORDER_COLOUR`	Customizes the border colour
`AUI_DOCKART_GRIPPER_COLOUR`	Customizes the gripper colour
`AUI_DOCKART_CAPTION_FONT`	Customizes the caption font
`AUI_DOCKART_GRADIENT_TYPE`	Customizes the gradient type (no gradient, vertical or horizontal)
`AUI_DOCKART_DRAW_SASH_GRIP`	Draw a sash grip on the sash
`AUI_DOCKART_HINT_WINDOW_COLOUR`	Customizes the hint window background colour (currently light blue)
`AUI_DOCKART_HINT_WINDOW_BORDER_COLOUR`	Customizes the hint window border background colour (currently grey)

Gradient Types

These are the possible gradient dock art settings for AuiDefaultDockArt:

Gradient Constant	Description
`AUI_GRADIENT_NONE`	No gradient on the captions
`AUI_GRADIENT_VERTICAL`	Vertical gradient on the captions
`AUI_GRADIENT_HORIZONTAL`	Horizontal gradient on the captions

Button States

These are the possible pane button / AuiNotebook button / AuiToolBar button states:

Button State Constant	Description
`AUI_BUTTON_STATE_NORMAL`	Normal button state
`AUI_BUTTON_STATE_HOVER`	Hovered button state
`AUI_BUTTON_STATE_PRESSED`	Pressed button state
`AUI_BUTTON_STATE_DISABLED`	Disabled button state
`AUI_BUTTON_STATE_HIDDEN`	Hidden button state
`AUI_BUTTON_STATE_CHECKED`	Checked button state

Button Identifiers

These are the possible pane button / AuiNotebook button / AuiToolBar button identifiers:

Button Identifier	Description
`AUI_BUTTON_CLOSE`	Shows a close button on the pane
`AUI_BUTTON_MAXIMIZE_RESTORE`	Shows a maximize/restore button on the pane
`AUI_BUTTON_MINIMIZE`	Shows a minimize button on the pane
`AUI_BUTTON_PIN`	Shows a pin button on the pane
`AUI_BUTTON_OPTIONS`	Shows an option button on the pane (not implemented)
`AUI_BUTTON_WINDOWLIST`	Shows a window list button on the pane (for `AuiNotebook`)
`AUI_BUTTON_LEFT`	Shows a left button on the pane (for `AuiNotebook`)
`AUI_BUTTON_RIGHT`	Shows a right button on the pane (for `AuiNotebook`)
`AUI_BUTTON_UP`	Shows an up button on the pane (not implemented)
`AUI_BUTTON_DOWN`	Shows a down button on the pane (not implemented)
`AUI_BUTTON_CUSTOM1`	Shows a custom button on the pane (not implemented)
`AUI_BUTTON_CUSTOM2`	Shows a custom button on the pane (not implemented)
`AUI_BUTTON_CUSTOM3`	Shows a custom button on the pane (not implemented)

Class Hierarchy¶

Inheritance diagram for class AuiDefaultDockArt:

Inheritance diagram of AuiDefaultDockArt

Known Subclasses¶

wx.lib.agw.aui.dockart.ModernDockArt

Methods Summary¶

`__init__`	Default class constructor.
`DrawBackground`	Draws a background.
`DrawBorder`	Draws the pane border.
`DrawCaption`	Draws the text in the pane caption.
`DrawCaptionBackground`	Draws the text caption background in the pane.
`DrawGripper`	Draws a gripper on the pane.
`DrawIcon`	Draws the icon in the pane caption area.
`DrawPaneButton`	Draws a pane button in the pane caption area.
`DrawSash`	Draws a sash between two windows.
`DrawSashGripper`	Draws a sash gripper on a sash between two windows.
`GetColor`	Gets the colour of a certain setting.
`GetFont`	Gets a font setting.
`GetMetric`	Gets the value of a certain setting.
`Init`	Initializes the dock art.
`RequestUserAttention`	Requests the user attention by intermittently highlighting the pane caption.
`SetColor`	Sets the colour of a certain setting.
`SetCustomPaneBitmap`	Sets a custom button bitmap for the pane button.
`SetDefaultColours`	Sets the default colours, which are calculated from the given base colour.
`SetDefaultPaneBitmaps`	Assigns the default pane bitmaps.
`SetFont`	Sets a font setting.
`SetMetric`	Sets the value of a certain setting using new_val

Class API¶

class AuiDefaultDockArt(object)¶

Dock art provider code - a dock 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 AuiManager uses an instance of this class called 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 AuiManager.SetArtProvider() to make use this new dock art.

Metric Ordinals

These are the possible pane dock art settings for AuiDefaultDockArt:

Metric Ordinal Constant	Description
`AUI_DOCKART_SASH_SIZE`	Customizes the sash size
`AUI_DOCKART_CAPTION_SIZE`	Customizes the caption size
`AUI_DOCKART_GRIPPER_SIZE`	Customizes the gripper size
`AUI_DOCKART_PANE_BORDER_SIZE`	Customizes the pane border size
`AUI_DOCKART_PANE_BUTTON_SIZE`	Customizes the pane button size
`AUI_DOCKART_BACKGROUND_COLOUR`	Customizes the background colour
`AUI_DOCKART_BACKGROUND_GRADIENT_COLOUR`	Customizes the background gradient colour
`AUI_DOCKART_SASH_COLOUR`	Customizes the sash colour
`AUI_DOCKART_ACTIVE_CAPTION_COLOUR`	Customizes the active caption colour
`AUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR`	Customizes the active caption gradient colour
`AUI_DOCKART_INACTIVE_CAPTION_COLOUR`	Customizes the inactive caption colour
`AUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR`	Customizes the inactive gradient caption colour
`AUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR`	Customizes the active caption text colour
`AUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR`	Customizes the inactive caption text colour
`AUI_DOCKART_BORDER_COLOUR`	Customizes the border colour
`AUI_DOCKART_GRIPPER_COLOUR`	Customizes the gripper colour
`AUI_DOCKART_CAPTION_FONT`	Customizes the caption font
`AUI_DOCKART_GRADIENT_TYPE`	Customizes the gradient type (no gradient, vertical or horizontal)
`AUI_DOCKART_DRAW_SASH_GRIP`	Draw a sash grip on the sash
`AUI_DOCKART_HINT_WINDOW_COLOUR`	Customizes the hint window background colour (currently light blue)
`AUI_DOCKART_HINT_WINDOW_BORDER_COLOUR`	Customizes the hint window border background colour (currently grey)

Gradient Types

These are the possible gradient dock art settings for AuiDefaultDockArt:

Gradient Constant	Description
`AUI_GRADIENT_NONE`	No gradient on the captions
`AUI_GRADIENT_VERTICAL`	Vertical gradient on the captions
`AUI_GRADIENT_HORIZONTAL`	Horizontal gradient on the captions

Button States

These are the possible pane button / AuiNotebook button / AuiToolBar button states:

Button State Constant	Description
`AUI_BUTTON_STATE_NORMAL`	Normal button state
`AUI_BUTTON_STATE_HOVER`	Hovered button state
`AUI_BUTTON_STATE_PRESSED`	Pressed button state
`AUI_BUTTON_STATE_DISABLED`	Disabled button state
`AUI_BUTTON_STATE_HIDDEN`	Hidden button state
`AUI_BUTTON_STATE_CHECKED`	Checked button state

Button Identifiers

These are the possible pane button / AuiNotebook button / AuiToolBar button identifiers:

Button Identifier	Description
`AUI_BUTTON_CLOSE`	Shows a close button on the pane
`AUI_BUTTON_MAXIMIZE_RESTORE`	Shows a maximize/restore button on the pane
`AUI_BUTTON_MINIMIZE`	Shows a minimize button on the pane
`AUI_BUTTON_PIN`	Shows a pin button on the pane
`AUI_BUTTON_OPTIONS`	Shows an option button on the pane (not implemented)
`AUI_BUTTON_WINDOWLIST`	Shows a window list button on the pane (for `AuiNotebook`)
`AUI_BUTTON_LEFT`	Shows a left button on the pane (for `AuiNotebook`)
`AUI_BUTTON_RIGHT`	Shows a right button on the pane (for `AuiNotebook`)
`AUI_BUTTON_UP`	Shows an up button on the pane (not implemented)
`AUI_BUTTON_DOWN`	Shows a down button on the pane (not implemented)
`AUI_BUTTON_CUSTOM1`	Shows a custom button on the pane (not implemented)
`AUI_BUTTON_CUSTOM2`	Shows a custom button on the pane (not implemented)
`AUI_BUTTON_CUSTOM3`	Shows a custom button on the pane (not implemented)

Methods¶

__init__(self)¶: Default class constructor.

DrawBackground(self, dc, window, orient, rect)¶

Draws a background.

Parameters:

dc – a wx.DC device context;
window – an instance of wx.Window;
orient (integer) – the gradient (if any) orientation;
rect (wx.Rect) – the background rectangle.

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

Draws the pane border.

Parameters:

dc – a wx.DC device context;
window – an instance of wx.Window;
rect (wx.Rect) – the border rectangle;
pane – the pane for which the border is drawn.

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

Draws the text in the pane caption.

Parameters:

dc – a wx.DC device context;
window – an instance of wx.Window;
text (string) – the text to be displayed;
rect (wx.Rect) – the pane caption rectangle;
pane – the pane for which the text is drawn.

DrawCaptionBackground(self, dc, rect, pane)¶

Draws the text caption background in the pane.

Parameters:

dc – a wx.DC device context;
rect (wx.Rect) – the text caption rectangle;
pane – the pane for which the text background is drawn.

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

Draws a gripper on the pane.

Parameters:

dc – a wx.DC device context;
window – an instance of wx.Window;
rect (wx.Rect) – the pane caption rectangle;
pane – the pane for which the gripper is drawn.

DrawIcon(self, dc, rect, pane)¶

Draws the icon in the pane caption area.

Parameters:

dc – a wx.DC device context;
rect (wx.Rect) – the pane caption rectangle;
pane – the pane for which the icon is drawn.

DrawPaneButton(self, dc, window, button, button_state, _rect, pane)¶

Draws a pane button in the pane caption area.

Parameters:

dc – a wx.DC device context;
window – an instance of wx.Window;
button (integer) – the button to be drawn;
button_state (integer) – the pane button state;
_rect (wx.Rect) – the pane caption rectangle;
pane – the pane for which the button is drawn.

DrawSash(self, dc, window, orient, rect)¶

Draws a sash between two windows.

Parameters:

dc – a wx.DC device context;
window – an instance of wx.Window;
orient (integer) – the sash orientation;
rect (wx.Rect) – the sash rectangle.

DrawSashGripper(self, dc, orient, rect)¶

Draws a sash gripper on a sash between two windows.

Parameters:

dc – a wx.DC device context;
orient (integer) – the sash orientation;
rect (wx.Rect) – the sash rectangle.

GetColor(self, id)¶

Gets the colour of a certain setting.

Parameters:: id (integer) – can be one of the colour values in Metric Ordinals.

GetFont(self, id)¶

Gets a font setting.

Parameters:: id (integer) – must be AUI_DOCKART_CAPTION_FONT, otherwise NullFont is returned.

GetMetric(self, id)¶

Gets the value of a certain setting.

Parameters:: id (integer) – can be one of the size values in Metric Ordinals.

Init(self)¶: Initializes the dock art.

RequestUserAttention(self, dc, window, text, rect, pane)¶

Requests the user attention by intermittently highlighting the pane caption.

Parameters:

dc – a wx.DC device context;
window – an instance of wx.Window;
text (string) – the text to be displayed;
rect (wx.Rect) – the pane caption rectangle;
pane – the pane for which we want to attract the user attention.

SetColor(self, id, colour)¶

Sets the colour of a certain setting.

Parameters:

id (integer) – can be one of the colour values in Metric Ordinals;
colour (wx.Colour or tuple or integer) – the new value of the setting.

SetCustomPaneBitmap(self, bmp, button, active, maximize=False)¶

Sets a custom button bitmap for the pane button.

Parameters:

bmp (wx.Bitmap) – the actual bitmap to set;
button (integer) – the button identifier;
active (bool) – whether it is the bitmap for the active button or not;
maximize (bool) – used to distinguish between the maximize and restore bitmaps.

SetDefaultColours(self, base_colour=None)¶

Sets the default colours, which are calculated from the given base colour.

Parameters:: base_colour – an instance of wx.Colour. If defaulted to None, a colour is generated accordingly to the platform and theme.

SetDefaultPaneBitmaps(self, isMac)¶

Assigns the default pane bitmaps.

Parameters:: isMac (bool) – whether we are on wxMAC or not.

SetFont(self, id, font)¶

Sets a font setting.

Parameters:

id (integer) – must be AUI_DOCKART_CAPTION_FONT;
font – an instance of wx.Font.

SetMetric(self, id, new_val)¶

Sets the value of a certain setting using new_val

Parameters:

id (integer) – can be one of the size values in Metric Ordinals;
new_val – the new value of the setting.

wx.lib.agw.aui.dockart.AuiDefaultDockArt¶

Class Hierarchy¶

Known Subclasses¶

Methods Summary¶

Class API¶

Methods¶

Table of Contents

This Page