Class TShgCell

class TShgCell;

Description

A spreadsheet engine cell.

Members

Defined in TShgCell:
Bool(), CloseFormula(), Coord(), CoordBitsOfKey(), EBlank, EBool, EErrDivByZero, EErrName, EErrNotAvailable, EErrNull, EErrNum, EErrRef, EErrValue, EError, EInt, ENoError, EReal, EText, ErrorType(), Formula(), Int(), IsShadow(), IsShadowOf(), IsTemporarilyReal(), Key(), MakeProperlyReal(), MakeShadow(), MakeTemporarilyReal(), MaximumKey(), MaximumKeyFromCoord(), MaximumKeyFromCoord(), MinimumKeyFromCoord(), MinimumKeyFromCoord(), Real(), ReturnCoord(), ReturnType(), Row(), SetBool(), SetErrorType(), SetFormulaL(), SetFormulaTakingOwnershipL(), SetInt(), SetReal(), SetTextTakingOwnership(), TErrorType, TShgCell(), TShgCell(), TType, Text(), Type()

IMPORT_C TShgCell();

Description

Default constructor.

IMPORT_C TShgCell(const TCellRef &aCellRef);

Description

Constructor, specifying a cell reference.

Parameters

const TCellRef &aCellRef Cell reference

IMPORT_C TCellRef Coord() const;

Description

Gets the cell reference.

Return value

TCellRef Cell reference

IMPORT_C TType Type() const;

Description

Gets the cell type.

Return value

TType Cell type

IMPORT_C void SetInt(TInt32 aInt);

Description

Sets the cell contents to an integer.

Parameters

TInt32 aInt New cell value

IMPORT_C TInt32 Int() const;

Description

Gets the value of an integer type cell.

The function panics if the cell is of another type.

Return value

TInt32 Cell value

IMPORT_C void SetBool(TBool aBool);

Description

Sets the cell contents to a boolean.

Parameters

TBool aBool New cell value

IMPORT_C TBool Bool() const;

Description

Gets the value of a boolean type cell.

The function panics if the cell is of another type.

Return value

TBool Cell value

IMPORT_C void SetErrorType(TErrorType aErrorType);

Description

Sets the cell contents to an error.

Parameters

TErrorType aErrorType New cell value

IMPORT_C TErrorType ErrorType() const;

Description

Gets the value of an error type cell.

The function panics if the cell is of another type.

Return value

TErrorType Cell value

IMPORT_C void SetReal(const TReal64 &aReal);

Description

Sets the cell contents to a real number.

Parameters

const TReal64 &aReal New cell value

IMPORT_C TReal64 Real() const;

Description

Gets the value of a real number type cell.

The function panics if the cell is of another type.

Return value

TReal64 Cell value

IMPORT_C void SetTextTakingOwnership(HBufC *aText);

Description

Sets the cell contents to a string.

The cell takes ownership of the passed string.

Parameters

HBufC *aText New cell value

IMPORT_C const TDesC &Text() const;

Description

Gets the value of a text type cell.

The function panics if the cell is of another type.

Return value

const TDesC & Cell value

IMPORT_C void SetFormulaL(CShgFormulaSet *aFormulaSet, const TDesC8 &aTokenFormula);

Description

Parameters

CShgFormulaSet *aFormulaSet const TDesC8 &aTokenFormula

IMPORT_C void SetFormulaTakingOwnershipL(CShgFormulaSet *aFormulaSet, TDesC8 *aTokenFormula);

Description

Parameters

CShgFormulaSet *aFormulaSet TDesC8 *aTokenFormula

IMPORT_C void CloseFormula(CShgFormulaSet *aFormulaSet);

Description

Parameters

CShgFormulaSet *aFormulaSet

IMPORT_C const TDesC8 *Formula() const;

Description

Gets the value of a formula type cell.

The function panics if the cell is of another type.

Return value

const TDesC8 * Cell value

inline TUint32 Key() const;

Description

Return value

TUint32

static inline TUint32 Row(TUint32 aKey);

Description

Parameters

TUint32 aKey

Return value

TUint32

static inline TUint32 CoordBitsOfKey();

Description

Return value

TUint32

static inline TUint32 MaximumKey();

Description

Return value

TUint32

static inline TUint32 MinimumKeyFromCoord(const TCellRef &aCellRef);

Description

Parameters

const TCellRef &aCellRef

Return value

TUint32

static inline TUint32 MinimumKeyFromCoord(TInt aRow, TInt aCol);

Description

Parameters

TInt aRow TInt aCol

Return value

TUint32

static inline TUint32 MaximumKeyFromCoord(const TCellRef &aCellRef);

Description

Parameters

const TCellRef &aCellRef

Return value

TUint32

static inline TUint32 MaximumKeyFromCoord(TInt aRow, TInt aCol);

Description

Parameters

TInt aRow TInt aCol

Return value

TUint32

inline TCellRef ReturnCoord() const;

Description

Return value

TCellRef

inline TType ReturnType() const;

Description

Return value

TType

inline TBool IsShadow() const;

Description

Return value

TBool

inline TBool IsShadowOf(const TShgCell &aRealCell) const;

Description

Parameters

const TShgCell &aRealCell

Return value

TBool

inline TBool IsTemporarilyReal() const;

Description

Return value

TBool

inline void MakeShadow();

Description

inline void MakeTemporarilyReal();

Description

inline void MakeProperlyReal();

Description

TErrorType

Description

Defines the error types that a cell can have.

ENoError No error. EErrNull Null intersection of ranges. EErrDivByZero Formula has tried to divide by zero. EErrValue An argument or operand is of the wrong type. EErrRef A cell is referred to that is not valid. EErrName An unrecognised name is used. EErrNum Numeric error, such as under, overflow, SQRT(-1). EErrNotAvailable No data available.

TType

Description

Defines cell types.

EBlank Blank cell. EInt Integer cell. EBool Boolean cell. EError Error cell. EReal Real number cell. EText Text cell.