wx.GridCtrl.Extended.IGridModel Interface Reference

Inheritance diagram for wx.GridCtrl.Extended.IGridModel:

wx.GridCtrl.Extended.BaseGridModel wx.GridCtrl.Extended.SparseGridModel

List of all members.

Public Member Functions

CellAttr GetCellAttrs (Point cellCoord)
string GetColumnLabel (int columnIndex)
CellAttr GetColumnLabelAttrs (int columnIndex)
string GetRowLabel (int rowIndex)
CellAttr GetRowLabelAttrs (int rowIndex)
object GetValue (Point cellCoord)
bool SetCellAttrs (Point cellCoord, CellAttr attr)
bool SetColumnLabel (int columnIndex, string newLabel)
bool SetRowLabel (int rowIndex, string newLabel)
bool SetValue (Point cellCoord, object value)
void UpdateValues (int minRowIndex, int maxRowIndex, int minColumnIndex, int maxColumnIndex)

Public Attributes

event
GridCellAttrChangedEventHandler 
OnAttributesChanged
event
GridCellValueChangedEventHandler 
OnValueChanged

Properties

GridCellLayoutSpecification CellLayout [get]
ColumnPropertiesCollection ColumnProperties [get]
CellAttr DefaultLabelAttr [get, set]
RowPropertiesCollection RowProperties [get]


Detailed Description

Data model of a grid. A grid model defines rows and columns to display and the associated data. Refer to class BaseGridModel implementing all stuff but the actually used data containers.

Member Function Documentation

CellAttr wx.GridCtrl.Extended.IGridModel.GetCellAttrs ( Point  cellCoord  ) 

The display attribute directly associated to a grid cell. These attributes will overide the default attributes of the grid, the attributes associated with the column, and the attributes associated with the row. The result of this method shall reflect the values that have been set by SetCellAttrs().

Parameters:
cellCoord The coordinates of the grid cell. The X coordinate provides the column index, the Y coordinate is the row index.
SetCellAttrs
Returns:

Implemented in wx.GridCtrl.Extended.BaseGridModel.

string wx.GridCtrl.Extended.IGridModel.GetColumnLabel ( int  columnIndex  ) 

Returns the column label. This may be null if unknown or undefined.

Parameters:
columnIndex The index of the labelled column.
Returns:

Implemented in wx.GridCtrl.Extended.BaseGridModel, and wx.GridCtrl.Extended.SparseGridModel.

CellAttr wx.GridCtrl.Extended.IGridModel.GetColumnLabelAttrs ( int  columnIndex  ) 

These are the display properties to display the column label of the designated column.

Parameters:
columnIndex The labelled column.
Returns:

Implemented in wx.GridCtrl.Extended.BaseGridModel.

string wx.GridCtrl.Extended.IGridModel.GetRowLabel ( int  rowIndex  ) 

Returns the row label. This may be null if unknown or undefined.

Parameters:
rowIndex The index of the labelled row.
Returns:

Implemented in wx.GridCtrl.Extended.BaseGridModel, and wx.GridCtrl.Extended.SparseGridModel.

CellAttr wx.GridCtrl.Extended.IGridModel.GetRowLabelAttrs ( int  rowIndex  ) 

These are the display properties to display the row label of the designated row.

Parameters:
rowIndex The labelled row.
Returns:

Implemented in wx.GridCtrl.Extended.BaseGridModel.

object wx.GridCtrl.Extended.IGridModel.GetValue ( Point  cellCoord  ) 

The value of a grid cell.

Parameters:
cellCoord The coordinates of the grid cell. The X coordinate provides the column index, the Y coordinate is the row index.
Returns:

Implemented in wx.GridCtrl.Extended.BaseGridModel, and wx.GridCtrl.Extended.SparseGridModel.

bool wx.GridCtrl.Extended.IGridModel.SetCellAttrs ( Point  cellCoord,
CellAttr  attr 
)

Assigns display attributes to the cell. Please note, that the grid model also provides the opportunity to use the cell attribute event.

Parameters:
cellCoord The coordinates of the grid cell. The X coordinate provides the column index, the Y coordinate is the row index.
attr The attribute that will be assigned. This can be null. In that case, any cell specific attributes will be removed. All attributes of this cell will be read from the grid, the column, or the row properties. Please note, that this instance will be made readonly.
Returns:
True if this has been successful. False if this is either not allowed or not implemented.

Implemented in wx.GridCtrl.Extended.BaseGridModel.

bool wx.GridCtrl.Extended.IGridModel.SetColumnLabel ( int  columnIndex,
string  newLabel 
)

Sets the column label.

Parameters:
columnIndex The index of the labelled column.
newLabel The new label.
Returns:

Implemented in wx.GridCtrl.Extended.BaseGridModel, and wx.GridCtrl.Extended.SparseGridModel.

bool wx.GridCtrl.Extended.IGridModel.SetRowLabel ( int  rowIndex,
string  newLabel 
)

Sets the row label.

Parameters:
rowIndex The index of the labelled row.
newLabel The new row label.
Returns:
True if successful. False if either not allowed or not implemented.

Implemented in wx.GridCtrl.Extended.BaseGridModel, and wx.GridCtrl.Extended.SparseGridModel.

bool wx.GridCtrl.Extended.IGridModel.SetValue ( Point  cellCoord,
object  value 
)

Assign a value to a cell. This will fire a ValueChanged event.

Parameters:
cellCoord The coordinates of the grid cell. The X coordinate provides the column index, the Y coordinate is the row index.
value The value that will be assigned to the cell.
Returns:
True if this has been successful. False if this is wither not allowed or not implemented.
Exceptions:
System.ArgumentException Throw an exception of this kind if the value does not fit into the cell. The message of this exception shall be a localized and informative text explaining the incompatibility.
See also:
ValueChanged

Implemented in wx.GridCtrl.Extended.BaseGridModel, and wx.GridCtrl.Extended.SparseGridModel.

void wx.GridCtrl.Extended.IGridModel.UpdateValues ( int  minRowIndex,
int  maxRowIndex,
int  minColumnIndex,
int  maxColumnIndex 
)

This will be called immediately before the grid reads values from the model for drawing. This method shall enable the model to create generated grid cell values en bloc immediately before the update of the display. The model can update grid cell values here and store them internally to be returned by method GetValue(). The grid model will indicate the range of indices of required rows and columns. However, the grid model must not rely on this method. GetValue() shall always return up to date values whether this has been called in advance or not.

Parameters:
maxColumnIndex The maximal index of an affected column.
maxRowIndex The maximal index of an affected row.
minColumnIndex The minimal index of an affected column.
minRowIndex The minimal index of an affected row.
GetValue

Implemented in wx.GridCtrl.Extended.BaseGridModel.


Member Data Documentation

event GridCellAttrChangedEventHandler wx.GridCtrl.Extended.IGridModel.OnAttributesChanged

This will be raised if the attributes of value cells or label cells change.

Implemented in wx.GridCtrl.Extended.BaseGridModel.

event GridCellValueChangedEventHandler wx.GridCtrl.Extended.IGridModel.OnValueChanged

This will be fired if one or more grid cell value changes.

Implemented in wx.GridCtrl.Extended.BaseGridModel.


Property Documentation

GridCellLayoutSpecification wx.GridCtrl.Extended.IGridModel.CellLayout [get]

Opportunity to define that some grid cells span over others.

Implemented in wx.GridCtrl.Extended.BaseGridModel.

ColumnPropertiesCollection wx.GridCtrl.Extended.IGridModel.ColumnProperties [get]

Collection of valid columns.

Implemented in wx.GridCtrl.Extended.BaseGridModel.

CellAttr wx.GridCtrl.Extended.IGridModel.DefaultLabelAttr [get, set]

Gets or sets the default label attributes. The labels returned by GetRowLabel() and GetColumnLabel() shall be the attributes set by SetRowLabel() or SetColumnLabel() completed by these default attribute.

Implemented in wx.GridCtrl.Extended.BaseGridModel.

RowPropertiesCollection wx.GridCtrl.Extended.IGridModel.RowProperties [get]

Collection of valid rows. This collection does, in fact, rather hold the properties used to display rows but not the data.

Implemented in wx.GridCtrl.Extended.BaseGridModel.


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