FBSpread Class Reference

FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread FBSpread

Inheritance diagram for FBSpread:

[legend]

List of all members.

---

Detailed Description

Base spreadsheet class.

See samples: ActionScriptMgr.py, KeyboardMapper.py, Spread.py.

Public Member Functions
object	GetCellValue (int pRow, int pColumn)
	Get a cell's value.
void	SetCellValue (int pRow, int pColumn, object pValue)
	Set a cell's value.
FBSpreadCell	GetSpreadCell (kReference pRef, int pColumn)
	Get a cell from row and column numbers.
	FBSpread ()
	Constructor.
	Clear ()
	Clear spreadsheet This function will empty spreadsheet of all its rows, columns and cells.
	ColumnAdd (str pString, kReference pRef=0)
	Add a column.
	GetCellView (kReference pRef, int pColumn, HIKtView pView)
	Get a cell's internal toolkit view.
FBSpreadColumn	GetColumn (int pColumn)
	Get a column from a column number.
FBSpreadCell	GetCurrentCell ()
	Get the current cell.
FBSpreadRow	GetRow (kReference pRef)
	Get a row from a row reference.
	RowAdd (str pString, kReference pRef=0)
	Add a row.
	RowSort (bool pAscending=True)
	Sort rows.
	SetCellView (kReference pRef, int pColumn, HIKtView pView)
	Set a cell's internal toolkit view.
Public Attributes
str	Caption
	Read Write Property: Caption to display for spreadsheet.
int	Column
	Read Write Property: Current column.
bool	MultiSelect
	Read Write Property: Can there be multiple selections?
FBEvent	OnCellChange
	Event: Cell value changed.
FBEvent	OnColumnClick
	Event: Column clicked.
FBEvent	OnDragAndDrop
	Event: Drag and drop event.
FBEvent	OnRowClick
	Event: Row clicked.
FBkReference	Row
	Read Write Property: Current row.

---

Constructor & Destructor Documentation

FBSpread

(

)

Constructor.

---

Member Function Documentation

object GetCellValue	(	int	pRow,
		int	pColumn
	)

Get a cell's value.

Parameters:

	pRow	Row of cell.
	pColumn	Column of cell.

Return values:

object

Value of the cell (can be str, int or float)

void SetCellValue	(	int	pRow,
		int	pColumn,
		object	pValue
	)

Set a cell's value.

This will also set the FBSpreadCell.Style to the type of pValue (kFBCellStyleInteger if pValue is an int, kFBCellStyleDouble if pValue is a float, kFBCellStyleString if pValue is a str).

Parameters:

	pRow	Row of cell.
	pColumn	Column of cell.
	pValue	Value of the cell (can be str, int or float)

FBSpreadCell GetSpreadCell	(	kReference	pRef,
		int	pColumn
	)

Get a cell from row and column numbers.

Parameters:

	pRef	Row reference.
	pColumn	Column number.

Returns:

A copy of the cell.

Clear

(

)

Clear spreadsheet This function will empty spreadsheet of all its rows, columns and cells.

ColumnAdd	(	str	pString,
		kReference	pRef = 0
	)

Add a column.

Parameters:

	pString	Text to display with column.
	pRef	User-define column reference number(default=0).

GetCellView	(	kReference	pRef,
		int	pColumn,
		HIKtView	pView
	)

Get a cell's internal toolkit view.

Parameters:

	pRef	Row of cell.
	pColumn	Column of cell.
	pView	Handle of view.

FBSpreadColumn GetColumn

(

int

pColumn

)

Get a column from a column number.

Parameters:

pColumn

Column number.

Returns:

A copy of column.

FBSpreadCell GetCurrentCell

(

)

Get the current cell.

Returns:

A copy of the the current cell.

FBSpreadRow GetRow

(

kReference

pRef

)

Get a row from a row reference.

Parameters:

pRef

Reference to a row.

Returns:

A copy of the row.

RowAdd	(	str	pString,
		kReference	pRef = 0
	)

Add a row.

Parameters:

	pString	Text to display with row.
	pRef	User-defined reference for row(default=0).

RowSort

(

bool

pAscending = True

)

Sort rows.

Parameters:

pAscending

If true, sort ascending.

SetCellView	(	kReference	pRef,
		int	pColumn,
		HIKtView	pView
	)

Set a cell's internal toolkit view.

Parameters:

	pRef	Row of cell.
	pColumn	Column of cell.
	pView	View to use to set cell's view.

---

Member Data Documentation

str Caption

Read Write Property: Caption to display for spreadsheet.

Reimplemented from FBVisualComponent.

int Column

Read Write Property: Current column.

bool MultiSelect

Read Write Property: Can there be multiple selections?

FBEvent OnCellChange

Event: Cell value changed.

FBEvent OnColumnClick

Event: Column clicked.

FBEvent OnDragAndDrop

Event: Drag and drop event.

FBEvent OnRowClick

Event: Row clicked.

FBkReference Row

Read Write Property: Current row.

---