## wxAuiDockArt

wxAuiDockArt is part of the wxAUI class framework. See also wxAUI overview.

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 wxAuiManager uses an instance of this class called wxAuiDefaultDockArt 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 wxAuiManager::SetArtProvider to make use this new dock art.

Derived from

No base class

Include files

<wx/aui/dockart.h>

See also

wxAuiManager, wxAuiPaneInfo

Data structures

    enum wxAuiPaneDockArtSetting
    {
        wxAUI_DOCKART_SASH_SIZE = 0,
        wxAUI_DOCKART_CAPTION_SIZE = 1,
        wxAUI_DOCKART_GRIPPER_SIZE = 2,
        wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
        wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
        wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
        wxAUI_DOCKART_SASH_COLOUR = 6,
        wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
        wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
        wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
        wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
        wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
        wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
        wxAUI_DOCKART_BORDER_COLOUR = 13,
        wxAUI_DOCKART_GRIPPER_COLOUR = 14,
        wxAUI_DOCKART_CAPTION_FONT = 15,
        wxAUI_DOCKART_GRADIENT_TYPE = 16
    }

    enum wxAuiPaneDockArtGradients

        wxAUI_GRADIENT_NONE = 0,
        wxAUI_GRADIENT_VERTICAL = 1,
        wxAUI_GRADIENT_HORIZONTAL = 2

    enum wxAuiPaneButtonState
    {
        wxAUI_BUTTON_STATE_NORMAL = 0,
        wxAUI_BUTTON_STATE_HOVER = 1,
        wxAUI_BUTTON_STATE_PRESSED = 2
    }

    enum wxAuiButtonId

        wxAUI_BUTTON_CLOSE = 101,
        wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
        wxAUI_BUTTON_MINIMIZE = 103,
        wxAUI_BUTTON_PIN = 104,
        wxAUI_BUTTON_OPTIONS = 105,
        wxAUI_BUTTON_WINDOWLIST = 106,
        wxAUI_BUTTON_LEFT = 107,
        wxAUI_BUTTON_RIGHT = 108,
        wxAUI_BUTTON_UP = 109,
        wxAUI_BUTTON_DOWN = 110,
        wxAUI_BUTTON_CUSTOM1 = 201,
        wxAUI_BUTTON_CUSTOM2 = 202,
        wxAUI_BUTTON_CUSTOM3 = 203
    ;

wxAuiDockArt::wxAuiDockArt
wxAuiDockArt::~wxAuiDockArt
wxAuiDockArt::DrawBackground
wxAuiDockArt::DrawBorder
wxAuiDockArt::DrawCaption
wxAuiDockArt::DrawGripper
wxAuiDockArt::DrawPaneButton
wxAuiDockArt::DrawSash
wxAuiDockArt::GetColor
wxAuiDockArt::GetColour
wxAuiDockArt::GetFont
wxAuiDockArt::GetMetric
wxAuiDockArt::SetColor
wxAuiDockArt::SetColour
wxAuiDockArt::SetFont
wxAuiDockArt::SetMetric

### wxAuiDockArt::wxAuiDockArt

wxAuiDockArt()

Constructor.

### wxAuiDockArt::~wxAuiDockArt

~wxAuiDockArt()

Destructor.

### wxAuiDockArt::DrawBackground

virtual void DrawBackground(wxDC& dc, wxWindow* window, int orientation, const wxRect& rect)

Draws a background.

### wxAuiDockArt::DrawBorder

virtual void DrawBorder(wxDC& dc, wxWindow* window, const wxRect& rect, wxAuiPaneInfo& pane)

Draws a border.

### wxAuiDockArt::DrawCaption

virtual void DrawCaption(wxDC& dc, wxWindow* window, const wxString& text, const wxRect& rect, wxAuiPaneInfo& pane)

Draws a caption.

### wxAuiDockArt::DrawGripper

virtual void DrawGripper(wxDC& dc, wxWindow* window, const wxRect& rect, wxAuiPaneInfo& pane)

Draws a gripper.

### wxAuiDockArt::DrawPaneButton

virtual void DrawPaneButton(wxDC& dc, wxWindow* window, int button, int button_state, const wxRect& rect, wxAuiPaneInfo& pane)

Draws a button in the pane's title bar.

button can be one of the values of wxAuiButtonId.

button_state can be one of the values of wxAuiPaneButtonState.

### wxAuiDockArt::DrawSash

virtual void DrawSash(wxDC& dc, wxWindow* window, int orientation, const wxRect& rect)

Draws a sash between two windows.

### wxAuiDockArt::GetColor

virtual wxColour GetColor(int id)

The same as GetColour.

### wxAuiDockArt::GetColour

virtual wxColour GetColour(int id)

Get the colour of a certain setting.

id can be one of the colour values of wxAuiPaneDockArtSetting.

### wxAuiDockArt::GetFont

virtual wxFont GetFont(int id)

Get a font setting.

### wxAuiDockArt::GetMetric

virtual int GetMetric(int id)

Get the value of a certain setting.

id can be one of the size values of wxAuiPaneDockArtSetting.

### wxAuiDockArt::SetColor

virtual void SetColor(int id, const wxColour& color)

The same as SetColour.

### wxAuiDockArt::SetColour

virtual void SetColour(int id, const wxColor& colour)

Set a certain setting with the value colour.

id can be one of the colour values of wxAuiPaneDockArtSetting.

### wxAuiDockArt::SetFont

virtual void SetFont(int id, const wxFont& font)

Set a font setting.

### wxAuiDockArt::SetMetric

virtual void SetMetric(int id, int new_val)

Set a certain setting with the value new_val.

id can be one of the size values of wxAuiPaneDockArtSetting.