***************** wx.aui.AuiDockArt ***************** Inheritance diagram for `wx.aui.AuiDockArt`: | .. inheritance-diagram:: wx.aui.AuiDockArt | Description =========== `wx.aui.AuiDockArt` is part of the wxAUI class framework. Dock art provider code -- a dock provider provides all drawing functionality to the wxAUI dock manager. This allows the dock manager to have a plugable look-and-feel. By default, a `wx.aui.AuiManager `_ uses an instance of this class called `wx.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 make use this new dock art. .. seealso:: `wx.aui.AuiPaneInfo `_, `wx.aui.AuiManager `_ Constants ^^^^^^^^^ Flags than can be used in methods `SetColor <#SetColor>`_, `SetColour <#SetColour>`_, `SetFont <#SetFont>`_, `SetMetric <#SetMetric>`_ and relative getters (coming from a structure called `wxAuiPaneDockArtSetting`): ======================================================== =================================================== Flags Value ======================================================== =================================================== ``wx.aui.AUI_DOCKART_SASH_SIZE`` 0 ``wx.aui.AUI_DOCKART_CAPTION_SIZE`` 1 ``wx.aui.AUI_DOCKART_GRIPPER_SIZE`` 2 ``wx.aui.AUI_DOCKART_PANE_BORDER_SIZE`` 3 ``wx.aui.AUI_DOCKART_PANE_BUTTON_SIZE`` 4 ``wx.aui.AUI_DOCKART_BACKGROUND_COLOUR`` 5 ``wx.aui.AUI_DOCKART_SASH_COLOUR`` 6 ``wx.aui.AUI_DOCKART_ACTIVE_CAPTION_COLOUR`` 7 ``wx.aui.AUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR`` 8 ``wx.aui.AUI_DOCKART_INACTIVE_CAPTION_COLOUR`` 9 ``wx.aui.AUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR`` 10 ``wx.aui.AUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR`` 11 ``wx.aui.AUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR`` 12 ``wx.aui.AUI_DOCKART_BORDER_COLOUR`` 13 ``wx.aui.AUI_DOCKART_GRIPPER_COLOUR`` 14 ``wx.aui.AUI_DOCKART_CAPTION_FONT`` 15 ``wx.aui.AUI_DOCKART_GRADIENT_TYPE`` 16 ======================================================== =================================================== | | Flags than can be used in method `SetMetric <#SetMetric>`_ and relative getter (coming from a structure called `wxAuiPaneDockArtGradients`): ======================================================== =================================================== Flags Value ======================================================== =================================================== ``wx.aui.AUI_GRADIENT_NONE`` 0 ``wx.aui.AUI_GRADIENT_VERTICAL`` 1 ``wx.aui.AUI_GRADIENT_HORIZONTAL`` 2 ======================================================== =================================================== | | Flags than can be used in method `DrawPaneButton <#DrawPaneButton>`_ (coming from a structure called `wxAuiPaneButtonState`): ======================================================== =================================================== Flags Value ======================================================== =================================================== ``wx.aui.AUI_BUTTON_STATE_NORMAL`` 0 ``wx.aui.AUI_BUTTON_STATE_HOVER`` 1 ``wx.aui.AUI_BUTTON_STATE_PRESSED`` 2 ======================================================== =================================================== | | Flags than can be used in method `DrawPaneButton <#DrawPaneButton>`_ (coming from a structure called `wxAuiButtonId`): ======================================================== =================================================== Flags Value ======================================================== =================================================== ``wx.aui.AUI_BUTTON_CLOSE`` 101 ``wx.aui.AUI_BUTTON_MAXIMIZE_RESTORE`` 102 ``wx.aui.AUI_BUTTON_MINIMIZE`` 103 ``wx.aui.AUI_BUTTON_PIN`` 104 ``wx.aui.AUI_BUTTON_OPTIONS`` 105 ``wx.aui.AUI_BUTTON_WINDOWLIST`` 106 ``wx.aui.AUI_BUTTON_LEFT`` 107 ``wx.aui.AUI_BUTTON_RIGHT`` 108 ``wx.aui.AUI_BUTTON_UP`` 109 ``wx.aui.AUI_BUTTON_DOWN`` 110 ``wx.aui.AUI_BUTTON_CUSTOM1`` 201 ``wx.aui.AUI_BUTTON_CUSTOM2`` 202 ``wx.aui.AUI_BUTTON_CUSTOM3`` 203 ======================================================== =================================================== Known Subclasses ^^^^^^^^^^^^^^^^ `wx.aui.AuiDefaultDockArt`, `wx.aui.PyAuiDockArt` Methods Summary ^^^^^^^^^^^^^^^ * `__init__ <#__init__>`_ * `DrawBackground <#DrawBackground>`_ * `DrawBorder <#DrawBorder>`_ * `DrawCaption <#DrawCaption>`_ * `DrawGripper <#DrawGripper>`_ * `DrawPaneButton <#DrawPaneButton>`_ * `DrawSash <#DrawSash>`_ * `GetColor <#GetColor>`_ * `GetColour <#GetColour>`_ * `GetFont <#GetFont>`_ * `GetMetric <#GetMetric>`_ * `SetColor <#SetColor>`_ * `SetColour <#SetColour>`_ * `SetFont <#SetFont>`_ * `SetMetric <#SetMetric>`_ Class API ========= Methods ^^^^^^^ .. method:: __init__() `No docstrings available for this method.` -------- .. method:: DrawBackground(dc, window, orientation, rect) Draws a background. **Parameters:** * `dc` (`wx.DC <../Widgets/wx.DC.html>`_) * `window` (`wx.Window <../Widgets/wx.Window.html>`_) * `orientation` (int) * `rect` (`wx.Rect <../Widgets/wx.Rect.html>`_) -------- .. method:: DrawBorder(dc, window, rect, pane) Draws a border. **Parameters:** * `dc` (`wx.DC <../Widgets/wx.DC.html>`_) * `window` (`wx.Window <../Widgets/wx.Window.html>`_) * `rect` (`wx.Rect <../Widgets/wx.Rect.html>`_) * `pane` (`wx.aui.AuiPaneInfo `_) -------- .. method:: DrawCaption(dc, window, text, rect, pane) Draws a caption. **Parameters:** * `dc` (`wx.DC <../Widgets/wx.DC.html>`_) * `window` (`wx.Window <../Widgets/wx.Window.html>`_) * `text` (string) * `rect` (`wx.Rect <../Widgets/wx.Rect.html>`_) * `pane` (`wx.aui.AuiPaneInfo `_) -------- .. method:: DrawGripper(dc, window, rect, pane) Draws a gripper. **Parameters:** * `dc` (`wx.DC <../Widgets/wx.DC.html>`_) * `window` (`wx.Window <../Widgets/wx.Window.html>`_) * `rect` (`wx.Rect <../Widgets/wx.Rect.html>`_) * `pane` (`wx.aui.AuiPaneInfo `_) -------- .. method:: DrawPaneButton(dc, window, button, button_state, rect, pane) Draws a button in the pane's title bar. **Parameters:** * `dc` (`wx.DC <../Widgets/wx.DC.html>`_) * `window` (`wx.Window <../Widgets/wx.Window.html>`_) * `button` (int): can be one of the values of `wx.AuiButtonId`. * `button_state` (int): can be one of the values of `wx.AuiPaneButtonState`. * `rect` (`wx.Rect <../Widgets/wx.Rect.html>`_) * `pane` (`wx.aui.AuiPaneInfo `_) -------- .. method:: DrawSash(dc, window, orientation, rect) Draws a sash between two windows. **Parameters:** * `dc` (`wx.DC <../Widgets/wx.DC.html>`_) * `window` (`wx.Window <../Widgets/wx.Window.html>`_) * `orientation` (int) * `rect` (`wx.Rect <../Widgets/wx.Rect.html>`_) -------- .. method:: GetColor(id) The same as `GetColour <#GetColour>`_. **Parameters:** * `id` (int): one of the id values of `wx.AuiPaneDockArtSetting`. | **Returns:** `wx.Colour <../Widgets/wx.Colour.html>`_ -------- .. method:: GetColour(id) Get the colour of a certain setting. **Parameters:** * `id` (int): one of the id values of `wx.AuiPaneDockArtSetting`. | **Returns:** `wx.Colour <../Widgets/wx.Colour.html>`_ -------- .. method:: GetFont(id) Get a font setting. **Parameters:** * `id` (int) | **Returns:** `wx.Font <../Widgets/wx.Font.html>`_ -------- .. method:: GetMetric(id) Get the value of a certain setting. **Parameters:** * `id` (int): one of the id values of `wx.AuiPaneDockArtSetting`. | **Returns:** `int` -------- .. method:: SetColor(id, color) The same as `SetColour <#SetColour>`_. **Parameters:** * `id` (int): one of the id values of `wx.AuiPaneDockArtSetting`. * `color` (`wx.Colour <../Widgets/wx.Colour.html>`_) -------- .. method:: SetColour(id, colour) Set a certain setting with the value `colour`. **Parameters:** * `id` (int): one of the id values of `wx.AuiPaneDockArtSetting`. * `colour` (`wx.Colour <../Widgets/wx.Colour.html>`_) -------- .. method:: SetFont(id, font) Set a font setting. **Parameters:** * `id` (int) * `font` (`wx.Font <../Widgets/wx.Font.html>`_) -------- .. method:: SetMetric(id, new_val) Set a certain setting with the value `new_val`. **Parameters:** * `id` (int): can be one of the size values of `wx.AuiPaneDockArtSetting`. * `new_val` (int)