Class: Wx::GRID::GridBlockCoords

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/grid/grid_ctrl.rb

Overview

Note:

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

Represents coordinates of a block of cells in the grid.

An object of this class contains coordinates of the left top and the bottom right corners of a block.

Requires:

  • USE_GRID

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::GRID::GridBlockCoords #initialize(topRow, leftCol, bottomRow, rightCol) ⇒ Wx::GRID::GridBlockCoords

Returns a new instance of GridBlockCoords.

Overloads:

  • #initialize ⇒ Wx::GRID::GridBlockCoords

    Default constructor initializes the object to invalid state.

    Initially the coordinates are invalid (-1) and so operator!() for an uninitialized Wx::GRID::GridBlockCoords returns true.

  • #initialize(topRow, leftCol, bottomRow, rightCol) ⇒ Wx::GRID::GridBlockCoords

    Constructor taking a coordinates of the left top and the bottom right corners.

    Parameters:

    • topRow (Integer)
    • leftCol (Integer)
    • bottomRow (Integer)
    • rightCol (Integer) 


2618
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2618

def initialize(*args) end

Instance Method Details

#==(other) ⇒ Boolean

Equality operator.

Parameters:

Returns:

  • (Boolean) 


2717
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2717

def ==(other) end

#canonicalize ⇒ Wx::GRID::GridBlockCoords

Return the canonicalized block where top left coordinates is less then bottom right coordinates.

Returns:



2676
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2676

def canonicalize; end

#contains(cell) ⇒ Boolean #contains(other) ⇒ Boolean

Overloads:

  • #contains(cell) ⇒ Boolean

    Check whether this block contains the given cell.

    true, if the block contains the cell, false otherwise.

    Parameters:

    • cell (Array(Integer, Integer))

    Returns:

    • (Boolean)
  • #contains(other) ⇒ Boolean

    Check whether this block contains another one.

    true if other is entirely contained within this block.

    Parameters:

    Returns:

    • (Boolean) 


2697
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2697

def contains(*args) end

#difference(other, splitOrientation) ⇒ Wx::GRID::GridBlockDiffResult

Calculates the result blocks by subtracting the other block from this block.

Up to 4 blocks. If block doesn’t exist in the result, it has value of Wx::GridNoBlockCoords.

Parameters:

Returns:



2705
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2705

def difference(other, splitOrientation) end

#get_bottom_right ⇒ Array(Integer, Integer) Also known as: bottom_right

Return the coordinates of the bottom right corner.

Returns:

  • (Array(Integer, Integer)) 


2671
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2671

def get_bottom_right; end

#get_bottom_row ⇒ Integer Also known as: bottom_row

Return the row of the bottom right corner.

Returns:

  • (Integer) 


2644
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2644

def get_bottom_row; end

#get_left_col ⇒ Integer Also known as: left_col

Return the column of the left top corner.

Returns:

  • (Integer) 


2633
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2633

def get_left_col; end

#get_right_col ⇒ Integer Also known as: right_col

Return the column of the bottom right corner.

Returns:

  • (Integer) 


2655
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2655

def get_right_col; end

#get_top_left ⇒ Array(Integer, Integer) Also known as: top_left

Return the coordinates of the top left corner.

Returns:

  • (Array(Integer, Integer)) 


2666
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2666

def get_top_left; end

#get_top_row ⇒ Integer Also known as: top_row

Return the row of the left top corner.

Returns:

  • (Integer) 


2622
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2622

def get_top_row; end

#intersects(other) ⇒ Boolean

Whether the blocks intersect.

true, if the block intersects with the other, false, otherwise.

Parameters:

Returns:

  • (Boolean) 


2683
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2683

def intersects(other) end

#set_bottom_row(row) ⇒ void Also known as: bottom_row=

This method returns an undefined value.

Set the row of the bottom right corner.

Parameters:

  • row (Integer) 


2650
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2650

def set_bottom_row(row) end

#set_left_col(col) ⇒ void Also known as: left_col=

This method returns an undefined value.

Set the column of the left top corner.

Parameters:

  • col (Integer) 


2639
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2639

def set_left_col(col) end

#set_right_col(col) ⇒ void Also known as: right_col=

This method returns an undefined value.

Set the column of the bottom right corner.

Parameters:

  • col (Integer) 


2661
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2661

def set_right_col(col) end

#set_top_row(row) ⇒ void Also known as: top_row=

This method returns an undefined value.

Set the row of the left top corner.

Parameters:

  • row (Integer) 


2628
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2628

def set_top_row(row) end

#sym_difference(other) ⇒ Wx::GRID::GridBlockDiffResult

Calculates the symmetric difference of the blocks.

Up to 4 blocks. If block doesn’t exist in the result, it has value of Wx::GridNoBlockCoords.

Parameters:

Returns:



2712
 
# File 'lib/wx/doc/gen/grid/grid_ctrl.rb', line 2712

def sym_difference(other) end