Class: Wx::AUI::AuiDockArt

Inherits:

Object

• Object
• Wx::AUI::AuiDockArt

Defined in:

lib/wx/doc/gen/aui/aui_dock_art.rb

Overview

AuiDockArt is part of the Wx::AUI class framework.

See also wxAUI Overview. AuiDockArt is the art provider: provides all drawing functionality to the Wx::AUI dock manager. This allows the dock manager to have a pluggable 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 Wx::AUI::AuiManager#set_art_provider to force Wx::AUI to use your new dock art provider.

Category: Window Docking (wxAUI)

See Also:

• AuiManager
• AuiPaneInfo

Requires:

• USE_AUI

Direct Known Subclasses

AuiDefaultDockArt

Instance Method Summary

• #clone ⇒ Wx::AUI::AuiDockArt

  Create a copy of this AuiDockArt instance.

• #draw_background(dc, window, orientation, rect) ⇒ void

  Draws a background.

• #draw_border(dc, window, rect, pane) ⇒ void

  Draws a border.

• #draw_caption(dc, window, text, rect, pane) ⇒ void

  Draws a caption.

• #draw_gripper(dc, window, rect, pane) ⇒ void

  Draws a gripper.

• #draw_pane_button(dc, window, button, button_state, rect, pane) ⇒ void

  Draws a button in the pane’s title bar.

• #draw_sash(dc, window, orientation, rect) ⇒ void

  Draws a sash between two windows.

• #get_colour(id) ⇒ Wx::Colour (also: #colour)

  Get the colour of a certain setting.

• #get_font(id) ⇒ Wx::Font (also: #font)

  Get a font setting.

• #get_metric(id) ⇒ Integer (also: #metric)

  Get the value of a certain setting.

• #initialize ⇒ Wx::AUI::AuiDockArt constructor

  Constructor.

• #set_colour(id, colour) ⇒ void

  Set a certain setting with the value colour.

• #set_font(id, font) ⇒ void

  Set a font setting.

• #set_metric(id, new_val) ⇒ void

  Set a certain setting with the value new_val.

Constructor Details

#initialize ⇒ Wx::AUI::AuiDockArt

Constructor.

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 219

def initialize; end

Instance Method Details

#clone ⇒ Wx::AUI::AuiDockArt

Create a copy of this Wx::AUI::AuiDockArt instance.

Returns:

• (Wx::AUI::AuiDockArt)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 223

def clone; end

#draw_background(dc, window, orientation, rect) ⇒ void

This method returns an undefined value.

Draws a background.

Parameters:

• dc (Wx::DC)
• window (Wx::Window)
• orientation (Integer)
• rect (Wx::Rect)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 231

def draw_background(dc, window, orientation, rect) end

#draw_border(dc, window, rect, pane) ⇒ void

This method returns an undefined value.

Draws a border.

Parameters:

• dc (Wx::DC)
• window (Wx::Window)
• rect (Wx::Rect)
• pane (Wx::AUI::AuiPaneInfo)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 239

def draw_border(dc, window, rect, pane) end

#draw_caption(dc, window, text, rect, pane) ⇒ void

This method returns an undefined value.

Draws a caption.

Parameters:

• dc (Wx::DC)
• window (Wx::Window)
• text (String)
• rect (Wx::Rect)
• pane (Wx::AUI::AuiPaneInfo)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 248

def draw_caption(dc, window, text, rect, pane) end

#draw_gripper(dc, window, rect, pane) ⇒ void

This method returns an undefined value.

Draws a gripper.

Parameters:

• dc (Wx::DC)
• window (Wx::Window)
• rect (Wx::Rect)
• pane (Wx::AUI::AuiPaneInfo)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 256

def draw_gripper(dc, window, rect, pane) end

#draw_pane_button(dc, window, button, button_state, rect, pane) ⇒ void

This method returns an undefined value.

Draws a button in the pane’s title bar.

button can be one of the values of Wx::AUI::AuiButtonId. button_state can be one of the values of Wx::AUI::AuiPaneButtonState.

Parameters:

• dc (Wx::DC)
• window (Wx::Window)
• button (Integer)
• button_state (Integer)
• rect (Wx::Rect)
• pane (Wx::AUI::AuiPaneInfo)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 268

def draw_pane_button(dc, window, button, button_state, rect, pane) end

#draw_sash(dc, window, orientation, rect) ⇒ void

This method returns an undefined value.

Draws a sash between two windows.

Parameters:

• dc (Wx::DC)
• window (Wx::Window)
• orientation (Integer)
• rect (Wx::Rect)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 276

def draw_sash(dc, window, orientation, rect) end

#get_colour(id) ⇒ Wx::Colour Also known as: colour

Get the colour of a certain setting.

id can be one of the colour values of Wx::AUI::AuiPaneDockArtSetting.

Parameters:

• id (Integer)

Returns:

• (Wx::Colour)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 283

def get_colour(id) end

#get_font(id) ⇒ Wx::Font Also known as: font

Get a font setting.

Parameters:

• id (Integer)

Returns:

• (Wx::Font)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 289

def get_font(id) end

#get_metric(id) ⇒ Integer Also known as: metric

Get the value of a certain setting.

id can be one of the size values of Wx::AUI::AuiPaneDockArtSetting.

Parameters:

• id (Integer)

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 297

def get_metric(id) end

#set_colour(id, colour) ⇒ void

This method returns an undefined value.

Set a certain setting with the value colour.

id can be one of the colour values of Wx::AUI::AuiPaneDockArtSetting.

Parameters:

• id (Integer)
• colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 306

def set_colour(id, colour) end

#set_font(id, font) ⇒ void

This method returns an undefined value.

Set a font setting.

Parameters:

• id (Integer)
• font (Wx::Font, Wx::FontInfo)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 312

def set_font(id, font) end

#set_metric(id, new_val) ⇒ void

This method returns an undefined value.

Set a certain setting with the value new_val.

id can be one of the size values of Wx::AUI::AuiPaneDockArtSetting.

Parameters:

• id (Integer)
• new_val (Integer)

# File 'lib/wx/doc/gen/aui/aui_dock_art.rb', line 320

def set_metric(id, new_val) end