Wx::AuiDockArt

AuiDockArt is part of the AUI class framework. See also AUI overview.

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#set_art_provider to make use this new dock art.

Derived from

No base class

See also

AuiManager, AuiPaneInfo

Data structures

enum AuiPaneDockArtSetting
{
    AUI_DOCKART_SASH_SIZE = 0,
    AUI_DOCKART_CAPTION_SIZE = 1,
    AUI_DOCKART_GRIPPER_SIZE = 2,
    AUI_DOCKART_PANE_BORDER_SIZE = 3,
    AUI_DOCKART_PANE_BUTTON_SIZE = 4,
    AUI_DOCKART_BACKGROUND_COLOUR = 5,
    AUI_DOCKART_SASH_COLOUR = 6,
    AUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
    AUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
    AUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
    AUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
    AUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
    AUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
    AUI_DOCKART_BORDER_COLOUR = 13,
    AUI_DOCKART_GRIPPER_COLOUR = 14,
    AUI_DOCKART_CAPTION_FONT = 15,
    AUI_DOCKART_GRADIENT_TYPE = 16
}

enum AuiPaneDockArtGradients
{
    AUI_GRADIENT_NONE = 0,
    AUI_GRADIENT_VERTICAL = 1,
    AUI_GRADIENT_HORIZONTAL = 2
}

enum AuiPaneButtonState
{
    AUI_BUTTON_STATE_NORMAL = 0,
    AUI_BUTTON_STATE_HOVER = 1,
    AUI_BUTTON_STATE_PRESSED = 2
}

enum AuiButtonId
{
    AUI_BUTTON_CLOSE = 101,
    AUI_BUTTON_MAXIMIZE_RESTORE = 102,
    AUI_BUTTON_MINIMIZE = 103,
    AUI_BUTTON_PIN = 104,
    AUI_BUTTON_OPTIONS = 105,
    AUI_BUTTON_WINDOWLIST = 106,
    AUI_BUTTON_LEFT = 107,
    AUI_BUTTON_RIGHT = 108,
    AUI_BUTTON_UP = 109,
    AUI_BUTTON_DOWN = 110,
    AUI_BUTTON_CUSTOM1 = 201,
    AUI_BUTTON_CUSTOM2 = 202,
    AUI_BUTTON_CUSTOM3 = 203
};

AuiDockArt.new

destructor()

Destructor.

AuiDockArt#draw_background

draw_background(DC dc,  Window window,  Integer orientation, 
                Rect rect)

Draws a background.

AuiDockArt#draw_border

draw_border(DC dc,  Window window,  Rect rect, 
            AuiPaneInfo pane)

Draws a border.

AuiDockArt#draw_caption

draw_caption(DC dc,  Window window,  String text, 
             Rect rect, 
             AuiPaneInfo pane)

Draws a caption.

AuiDockArt#draw_gripper

draw_gripper(DC dc,  Window window,  Rect rect, 
             AuiPaneInfo pane)

Draws a gripper.

AuiDockArt#draw_pane_button

draw_pane_button(DC dc,  Window window,  Integer button, 
                 Integer button_state, 
                 Rect rect, 
                 AuiPaneInfo pane)

Draws a button in the pane’s title bar.

button can be one of the values of AuiButtonId.

button_state can be one of the values of AuiPaneButtonState.

AuiDockArt#draw_sash

draw_sash(DC dc,  Window window,  Integer orientation, 
          Rect rect)

Draws a sash between two windows.

AuiDockArt#get_color

Colour get_color(Integer id)

The same as get_colour.

AuiDockArt#get_colour

Colour get_colour(Integer id)

Get the colour of a certain setting.

id can be one of the colour values of AuiPaneDockArtSetting.

AuiDockArt#get_font

Font get_font(Integer id)

Get a font setting.

AuiDockArt#get_metric

Integer get_metric(Integer id)

Get the value of a certain setting.

id can be one of the size values of AuiPaneDockArtSetting.

AuiDockArt#set_color

set_color(Integer id,  Colour color)

The same as set_colour.

AuiDockArt#set_colour

set_colour(Integer id,  Color colour)

Set a certain setting with the value colour.

id can be one of the colour values of AuiPaneDockArtSetting.

AuiDockArt#set_font

set_font(Integer id,  Font font)

Set a font setting.

AuiDockArt#set_metric

set_metric(Integer id,  Integer new_val)

Set a certain setting with the value new_val.

id can be one of the size values of AuiPaneDockArtSetting.

[This page automatically generated from the Textile source at Fri Oct 31 16:06:38 +0000 2008]