Class: Wx::DCOverlay

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/dc_overlay.rb,
lib/wx/doc/dc_overlay.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

Connects an overlay with a drawing DC.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.draw_on(overlay, dc) {|ovl_dc| ... } ⇒ ::Object .draw_on(overlay, dc, x, y, width, height) {|ovl_dc| ... } ⇒ ::Object

Connects this overlay to the corresponding drawing dc. If the overlay is not initialized yet, this call will do so. Creates a Wx::DCOverlay instance for to do that and passes the instance to the given block to use. Uses either the entire area of the drawing DC or the area specified.

Overloads:

  • .draw_on(overlay, dc) {|ovl_dc| ... } ⇒ ::Object

    Returns result from block.

    Parameters:

    Yield Parameters:

    Returns:

    • (::Object) —

      result from block

  • .draw_on(overlay, dc, x, y, width, height) {|ovl_dc| ... } ⇒ ::Object

    Returns result from block.

    Parameters:

    • overlay (Wx::Overlay) —

      Overlay to connect

    • dc (Wx::DC) —

      Drawing DC

    • x (Integer) —

      topleft x coordinate of area to use

    • y (Integer) —

      topleft y coordinate of area to use

    • width (Integer) —

      width of area to use

    • height (Integer) —

      height of area to use

    Yield Parameters:

    Returns:

    • (::Object) —

      result from block



31
 
# File 'lib/wx/doc/dc_overlay.rb', line 31

def self.draw_on(*arg) end

Instance Method Details

#clear ⇒ void

This method returns an undefined value.

Clears the layer, restoring the state at the last init.



22
 
# File 'lib/wx/doc/gen/dc_overlay.rb', line 22

def clear; end