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 SetArtProvider to make use this new dock art.
Metric Ordinals
These are the possible pane dock art settings for AuiManager:
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 for AuiManager:
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 | 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. |
GetColour | 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. |
SetColour | 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 |
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 for AuiManager:
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 for AuiManager:
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) |
Draws the text caption background in the pane.
Parameters: |
|
---|
Draws the icon in the pane caption area.
Parameters: |
|
---|
Draws a pane button in the pane caption area.
Parameters: |
---|
Draws a sash gripper on a sash between two windows.
Parameters: |
|
---|
Gets the colour of a certain setting.
Parameters: | id – can be one of the colour values in Metric Ordinals. |
---|
Gets the colour of a certain setting.
Parameters: | id – can be one of the colour values in Metric Ordinals. |
---|
Gets a font setting.
Parameters: | id – must be AUI_DOCKART_CAPTION_FONT, otherwise wx.NullFont is returned. |
---|
Gets the value of a certain setting.
Parameters: | id – can be one of the size values in Metric Ordinals. |
---|
Requests the user attention by intermittently highlighting the pane caption.
Parameters: |
---|
Sets the colour of a certain setting.
Parameters: |
|
---|
Sets the colour of a certain setting.
Parameters: |
|
---|
Sets a custom button bitmap for the pane button.
Parameters: |
|
---|
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. |
---|
Assigns the default pane bitmaps.
Parameters: | isMac – whether we are on wxMAC or not. |
---|
Sets a font setting.
Parameters: |
|
---|