Class: Wx::AUI::AuiDefaultDockArt

Inherits:
AuiDockArt show all
Defined in:
lib/wx/doc/gen/aui/aui_dock_art.rb

Overview

This is the default art provider for AuiManager.

Dock art can be customized by creating a class derived from this one, or replacing this class entirely.

Requires:

  • USE_AUI

Instance Method Summary collapse

Methods inherited from AuiDockArt

#get_metric_for_window

Constructor Details

#initializeWx::AUI::AuiDefaultDockArt



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

def initialize; end

Instance Method Details

#cloneWx::AUI::AuiDockArt

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

Returns:



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

def clone; end

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

This method returns an undefined value.

Draws a background.

Parameters:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

def get_colour(id) end

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

Get a font setting.

Parameters:

  • id (Integer)

Returns:



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

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. This function returns the same value that was set by #set_metric, use Wx::AUI::AuiDockArt#get_metric_for_window to get the value appropriate for the given window for metrics that express sizes.

Parameters:

  • id (Integer)

Returns:

  • (Integer)


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

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)


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

def set_colour(id, colour) end

#set_font(id, font) ⇒ void

This method returns an undefined value.

Set a font setting.

Parameters:



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

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. The interpretation of new_val depends on the metric being set, see Wx::AUI::AuiDockArt#get_metric_for_window.

Parameters:

  • id (Integer)
  • new_val (Integer)


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

def set_metric(id, new_val) end