Class: Wx::AUI::AuiDockArt

Inherits:
Object
  • Object
show all
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:

Requires:

  • USE_AUI

Direct Known Subclasses

AuiDefaultDockArt

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::AUI::AuiDockArt

Constructor.



219
 
# 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:



223
 
# 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:



231
 
# 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:



239
 
# 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:



248
 
# 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:



256
 
# 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:



268
 
# 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:



276
 
# 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:



283
 
# 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:



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

Parameters:

  • id (Integer)

Returns:

  • (Integer) 


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

def get_metric(id) end

#get_metric_for_window(id, window) ⇒ Integer Also known as: metric_for_window

Get metric value scaled by the DPI of the given window if appropriate.

Call this function instead of #get_metric to get the metric value scaled by the window DPI for the metrics that are expressed in pixels and must be scaled. The default implementation doesn’t scale Wx::AUI::AuiPaneDockArtSetting::AUI_DOCKART_SASH_SIZE and Wx::AUI::AuiPaneDockArtSetting::AUI_DOCKART_PANE_BORDER_SIZE metrics in order to allow setting them to just a single pixel (which is the default value for the latter in Wx::AUI::AuiDefaultDockArt) even in high DPI. You may override this function in your custom art implementation to scale these metrics too if you prefer to have thicker borders in high DPI. Note that values of Wx::AUI::AuiPaneDockArtSetting::AUI_DOCKART_GRADIENT_TYPE are not expressed in pixels and so should never be scaled by this function.

Parameters:

Returns:

  • (Integer) 


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

def get_metric_for_window(id, window) 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) 


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

def set_colour(id, colour) end

#set_font(id, font) ⇒ void

This method returns an undefined value.

Set a font setting.

Parameters:



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

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 #get_metric_for_window.

Parameters:

  • id (Integer)
  • new_val (Integer) 


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

def set_metric(id, new_val) end