dockart.AuiDefaultDockArt

Inheritance diagram for AuiDefaultDockArt:


digraph inheritancec213f0bde2 {
rankdir=LR;
size="8.0, 12.0";
  "dockart.AuiDefaultDockArt" [style="setlinewidth(0.5)",URL="#dockart.AuiDefaultDockArt",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Description

Dock art provider code - a dock 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 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:

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

Gradient Types

These are the possible gradient dock art settings:

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 API

Methods

class AuiDefaultDockArt

Bases: 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 plugable 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:

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

Gradient Types

These are the possible gradient dock art settings:

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)
__init__()
Default class constructor.
DrawBackground(dc, window, orient, rect)

Draws a background.

Parameters:
  • dc – a wx.DC device context;
  • window – an instance of wx.Window;
  • orient – the gradient (if any) orientation;
  • rect – the background rectangle.
DrawBorder(dc, window, rect, pane)

Draws the pane border.

Parameters:
  • dc – a wx.DC device context;
  • window – an instance of wx.Window;
  • rect – the border rectangle;
  • pane – the pane for which the border is drawn.
DrawCaption(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 – the text to be displayed;
  • rect – the pane caption rectangle;
  • pane – the pane for which the text is drawn.
DrawCaptionBackground(dc, rect, active)

Draws the text caption background in the pane.

Parameters:
  • dc – a wx.DC device context;
  • rect – the text caption rectangle;
  • active – whether the pane is active or not.
DrawGripper(dc, window, rect, pane)

Draws a gripper on the pane.

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

Draws the icon in the pane caption area.

Parameters:
  • dc – a wx.DC device context;
  • rect – the pane caption rectangle;
  • pane – the pane for which the icon is drawn.
DrawPaneButton(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 – the button to be drawn;
  • button_state – the pane button state;
  • _rect – the pane caption rectangle;
  • pane – the pane for which the button is drawn.
DrawSash(dc, window, orient, rect)

Draws a sash between two windows.

Parameters:
  • dc – a wx.DC device context;
  • window – an instance of wx.Window;
  • orient – the sash orientation;
  • rect – the sash rectangle.
DrawSashGripper(dc, orient, rect)

Draws a sash gripper on a sash between two windows.

Parameters:
  • dc – a wx.DC device context;
  • orient – the sash orientation;
  • rect – the sash rectangle.
GetColor(id)

Gets the colour of a certain setting.

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

Gets the colour of a certain setting.

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

Gets a font setting.

Parameter:id – must be AUI_DOCKART_CAPTION_FONT, otherwise wx.NullFont is returned.
GetMetric(id)

Gets the value of a certain setting.

Parameter:id – can be one of the size values in Metric Ordinals.
SetColor(id, colour)

Sets the colour of a certain setting.

Parameters:
  • id – can be one of the colour values in Metric Ordinals;
  • new_val – the new value of the setting.
SetColour(id, colour)

Sets the colour of a certain setting.

Parameters:
  • id – can be one of the colour values in Metric Ordinals;
  • new_val – the new value of the setting.
SetFont(id, font)

Sets a font setting.

Parameters:
  • id – must be AUI_DOCKART_CAPTION_FONT;
  • font – an instance of wx.Font.
SetMetric(id, new_val)

Sets the value of a certain setting using new_val

Parameters:
  • id – can be one of the size values in Metric Ordinals;
  • new_val – the new value of the setting.

Table Of Contents

This Page