wx.GridCtrl.Extended.GridCellLayoutSpecification Class Reference

List of all members.

Public Member Functions

Size GetCellSpan (Point cellCoord)
 GridCellLayoutSpecification ()
Point OverlayedByThis (Point cellCoord)
void SetColumnAndRowSpan (Point cellCoord, int colspan, int rowspan)
void SetColumnSpan (Point cellCoord, int colspan)
void SetRowSpan (Point cellCoord, int rowspan)
Point TopLeftCornerOfOverlappings (Point topLeftCornerOfRectOfInterest)


Detailed Description

Instances of this class manage data on those cells spanning over more than one column or row.

Constructor & Destructor Documentation

wx.GridCtrl.Extended.GridCellLayoutSpecification.GridCellLayoutSpecification (  ) 


Member Function Documentation

Size wx.GridCtrl.Extended.GridCellLayoutSpecification.GetCellSpan ( Point  cellCoord  ) 

This cell spans over a number of columns according to the width of the result and a number of rows according to the height of the result. If the argument denotes a cell that spans over nothing in the neighbourhood, the result is 1x1.

Parameters:
cellCoord The cell that might span over others.
Returns:

Point wx.GridCtrl.Extended.GridCellLayoutSpecification.OverlayedByThis ( Point  cellCoord  ) 

Use this to find out whether a cell is visible or another cell spans over it.

Parameters:
cellCoord The cell that you want to know whether another cell spans over it or not.
Returns:
The coordinates of the cell that spans over the argument or null if this cell is visible.

void wx.GridCtrl.Extended.GridCellLayoutSpecification.SetColumnAndRowSpan ( Point  cellCoord,
int  colspan,
int  rowspan 
)

Defines row and column span of a certain cell in one step, i.e. this cell is set to span over more than one row and more than one column. A full square of cells will be overlayed by this cell.

Parameters:
cellCoord The coordinates of the cell. X is the column index, Y is the row index.
columnIndex The column of the cell spanning over more than one row.
rowspan The cell spans over this number of rows.
Exceptions:
ArgumentOutOfRangeException Will be thrown if rowspan is smaller than 1.

void wx.GridCtrl.Extended.GridCellLayoutSpecification.SetColumnSpan ( Point  cellCoord,
int  colspan 
)

Defines the colspan of a certain cell, i.e. this cell is set to span over more than one column. If this cell also spans over more than one row, a full square of cells will be overlayed by this cell.

Parameters:
cellCoord The coordinates of the cell spanning over more than one column. X is the column index, Y is the row index.
colspan The cell spans over this number of columns.
Exceptions:
ArgumentOutOfRangeException Will be thrown if colspan is smaller than 1.

void wx.GridCtrl.Extended.GridCellLayoutSpecification.SetRowSpan ( Point  cellCoord,
int  rowspan 
)

Defines the row span of a certain cell, i.e. this cell is set to span over more than one row. If this cell also spans over more than one column, a full square of cells will be overlayed by this cell.

Parameters:
cellCoord The coordinates of the cell spanning over more than one row. X is the column index, Y is the row index.
rowspan The cell spans over this number of rows.
Exceptions:
ArgumentOutOfRangeException Will be thrown if rowspan is smaller than 1.

Point wx.GridCtrl.Extended.GridCellLayoutSpecification.TopLeftCornerOfOverlappings ( Point  topLeftCornerOfRectOfInterest  ) 

Methode to compute the minimal rectangle containing the origin of all cells that are visible in another rectangle specified by the parameter list. This is usually simply the rectangle from the argument list. However, differences result from cell spanning over more than one row or column with coordinates outside the rectangle from the parameter list. Assume, that we have a rectangle specified by the top left corner (2 (columnn),2 (row)) in the parameter list. Assume furthermore, that cell (2,1) with row span 2 and a cell (0,2) with column span 3. This will result into a rectangle specified by the top left corner (0,1) containing also the origins (2,1) and (0,2) of those cells spanning over cells in the visible region.

Parameters:
topLeftCornerOfRectOfInterest Top left corner of the visible rectangle.
Returns:
The top left corner of the rectangle containing the visible cells and the origin of those cells spanning over visible cells.


Manual of the wx.NET   (c) 2003-2011 the wx.NET project at   Get wx.NET at SourceForge.net. Fast, secure and Free Open Source software downloads