FBSpread Class Reference

This reference page is linked to from the following overview topics: Events & callbacks.

---

Search for all occurrences

---

Detailed Description

Base spreadsheet class.

Definition at line 1501 of file fbcontrols.h.

#include <fbcontrols.h>

Inheritance diagram for FBSpread:

List of all members.

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

---

Constructor & Destructor Documentation

FBSpread

(

)

Constructor.

---

Member Function Documentation

virtual void RowAdd	(	char *	pString,
		kReference	pRef = 0
	)		[virtual]

Search for all occurrences

Add a row.

Parameters:

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

virtual void RowSort

(

bool

pAscending = true

)

[virtual]

Search for all occurrences

Sort rows.

Parameters:

pAscending

If true, sort ascending.

virtual void ColumnAdd	(	char *	pString,
		kReference	pRef = 0
	)		[virtual]

Search for all occurrences

Add a column.

Parameters:

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

virtual FBSpreadCell GetCurrentCell

(

)

[virtual]

Search for all occurrences

Get the current cell.

Returns:

A copy of the the current cell.

virtual FBSpreadCell GetCell	(	kReference	pRef,
		int	pColumn
	)		[virtual]

Search for all occurrences

Get a cell from row and column numbers.

Parameters:

pRef	Row reference.
pColumn	Column number.

Returns:

A copy of the cell.

virtual FBSpreadColumn GetColumn

(

int

pColumn

)

[virtual]

Search for all occurrences

Get a column from a column number.

Parameters:

pColumn

Column number.

Returns:

A copy of column.

virtual FBSpreadRow GetRow

(

kReference

pRef

)

[virtual]

Search for all occurrences

Get a row from a row reference.

Parameters:

pRef	Reference to a row.

Returns:

A copy of the row.

virtual void SetCell	(	kReference	pRef,
		int	pColumn,
		char *	pString
	)		[virtual]

Search for all occurrences

Set a cell's value.

Parameters:

pRef	Row of cell.
pColumn	Column of cell.
pString	Cell's new value.

virtual void SetCell	(	kReference	pRef,
		int	pColumn,
		int	pValue
	)		[virtual]

Search for all occurrences

Set a cell's value.

Parameters:

pRef	Row of cell.
pColumn	Column of cell.
pValue	Cell's new value.

virtual void SetCell	(	kReference	pRef,
		int	pColumn,
		kLongLong	pValue
	)		[virtual]

Search for all occurrences

virtual void SetCell	(	kReference	pRef,
		int	pColumn,
		double	pValue
	)		[virtual]

Search for all occurrences

virtual void GetCell	(	kReference	pRef,
		int	pColumn,
		char *&	pString
	)		[virtual]

Search for all occurrences

Get a cell's value.

Parameters:

pRef	Row of cell.
pColumn	Column of cell.

Return values:

pString

String value of cell.

virtual void GetCell	(	kReference	pRef,
		int	pColumn,
		int &	pValue
	)		[virtual]

Search for all occurrences

Get a cell's value.

Parameters:

pRef	Row of cell.
pColumn	Column of cell.

Return values:

pValue

Numeric value of cell.

virtual void GetCell	(	kReference	pRef,
		int	pColumn,
		kLongLong &	pValue
	)		[virtual]

Search for all occurrences

virtual void GetCell	(	kReference	pRef,
		int	pColumn,
		double &	pValue
	)		[virtual]

Search for all occurrences

virtual void SetCellView	(	kReference	pRef,
		int	pColumn,
		HIKtView	pView
	)		[virtual]

Search for all occurrences

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.

virtual void GetCellView	(	kReference	pRef,
		int	pColumn,
		HIKtView &	pView
	)		[virtual]

Search for all occurrences

Get a cell's internal toolkit view.

Parameters:

pRef	Row of cell.
pColumn	Column of cell.

Return values:

pView

Handle of view.

virtual void Clear

(

)

[virtual]

Search for all occurrences

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

---

Member Data Documentation

FBPropertyString Caption

Search for all occurrences

Read Write Property: Caption to display for spreadsheet.

Reimplemented from FBVisualComponent.

Definition at line 1508 of file fbcontrols.h.

FBPropertykReference Row

Search for all occurrences

Read Write Property: Current row.

Definition at line 1509 of file fbcontrols.h.

FBPropertyInt Column

Search for all occurrences

Read Write Property: Current column.

Definition at line 1510 of file fbcontrols.h.

FBPropertyBool MultiSelect

Search for all occurrences

Read Write Property: Can there be multiple selections?

Definition at line 1511 of file fbcontrols.h.

FBPropertyEvent OnCellChange

Search for all occurrences

Event: Cell value changed.

Definition at line 1513 of file fbcontrols.h.

FBPropertyEvent OnRowClick

Search for all occurrences

Event: Row clicked.

Definition at line 1514 of file fbcontrols.h.

FBPropertyEvent OnColumnClick

Search for all occurrences

Event: Column clicked.

Definition at line 1515 of file fbcontrols.h.

FBPropertyEvent OnDragAndDrop

Search for all occurrences

Event: Drag and drop event.

Definition at line 1516 of file fbcontrols.h.

---

The documentation for this class was generated from the following file:

• fbcontrols/fbcontrols.h