Public Member Functions | Public Attributes

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 1513 of file fbcontrols.h.

#include <fbcontrols.h>

Inheritance diagram for FBSpread:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBSpread ()
 Constructor.
virtual void RowAdd (const char *pString, kReference pRef=0)
 Add a row.
virtual void RowSort (bool pAscending=true)
 Sort rows.
virtual void ColumnAdd (const 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, const char *pString)
 Set a cell's value.
virtual void GetCell (kReference pRef, int pColumn, const 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 ( const char *  pString,
kReference  pRef = 0 
) [virtual]

Add a row.

Parameters:
pStringText to display with row.
pRefUser-defined reference for row(default=0).
virtual void RowSort ( bool  pAscending = true) [virtual]

Sort rows.

Parameters:
pAscendingIf true, sort ascending.
virtual void ColumnAdd ( const char *  pString,
kReference  pRef = 0 
) [virtual]

Add a column.

Parameters:
pStringText to display with column.
pRefUser-define column reference number(default=0).
virtual FBSpreadCell GetCurrentCell ( ) [virtual]

Get the current cell.

Returns:
A copy of the the current cell.
virtual FBSpreadCell GetCell ( kReference  pRef,
int  pColumn 
) [virtual]

Get a cell from row and column numbers.

Parameters:
pRefRow reference.
pColumnColumn number.
Returns:
A copy of the cell.
virtual FBSpreadColumn GetColumn ( int  pColumn) [virtual]

Get a column from a column number.

Parameters:
pColumnColumn number.
Returns:
A copy of column.
virtual FBSpreadRow GetRow ( kReference  pRef) [virtual]

Get a row from a row reference.

Parameters:
pRefReference to a row.
Returns:
A copy of the row.
virtual void SetCell ( kReference  pRef,
int  pColumn,
const char *  pString 
) [virtual]

Set a cell's value.

Parameters:
pRefRow of cell.
pColumnColumn of cell.
pStringCell's new value.
virtual void SetCell ( kReference  pRef,
int  pColumn,
int  pValue 
) [virtual]

Set a cell's value.

Parameters:
pRefRow of cell.
pColumnColumn of cell.
pValueCell's new value.
virtual void SetCell ( kReference  pRef,
int  pColumn,
kLongLong  pValue 
) [virtual]
virtual void SetCell ( kReference  pRef,
int  pColumn,
double  pValue 
) [virtual]
virtual void GetCell ( kReference  pRef,
int  pColumn,
const char *&  pString 
) [virtual]

Get a cell's value.

Parameters:
pRefRow of cell.
pColumnColumn of cell.
Return values:
pStringString value of cell.
virtual void GetCell ( kReference  pRef,
int  pColumn,
int &  pValue 
) [virtual]

Get a cell's value.

Parameters:
pRefRow of cell.
pColumnColumn of cell.
Return values:
pValueNumeric value of cell.
virtual void GetCell ( kReference  pRef,
int  pColumn,
kLongLong pValue 
) [virtual]
virtual void GetCell ( kReference  pRef,
int  pColumn,
double &  pValue 
) [virtual]
virtual void SetCellView ( kReference  pRef,
int  pColumn,
HIKtView  pView 
) [virtual]

Set a cell's internal toolkit view.

Parameters:
pRefRow of cell.
pColumnColumn of cell.
pViewView to use to set cell's view.
virtual void GetCellView ( kReference  pRef,
int  pColumn,
HIKtView &  pView 
) [virtual]

Get a cell's internal toolkit view.

Parameters:
pRefRow of cell.
pColumnColumn of cell.
Return values:
pViewHandle of view.
virtual void Clear ( ) [virtual]

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


Member Data Documentation

Read Write Property: Caption to display for spreadsheet.

Reimplemented from FBVisualComponent.

Definition at line 1520 of file fbcontrols.h.

Read Write Property: Current row.

Definition at line 1521 of file fbcontrols.h.

Read Write Property: Current column.

Definition at line 1522 of file fbcontrols.h.

Read Write Property: Can there be multiple selections?

Definition at line 1523 of file fbcontrols.h.

Event: Cell value changed.

Definition at line 1525 of file fbcontrols.h.

Event: Row clicked.

Definition at line 1526 of file fbcontrols.h.

Event: Column clicked.

Definition at line 1527 of file fbcontrols.h.

Event: Drag and drop event.

Definition at line 1528 of file fbcontrols.h.


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

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