Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <SHGAPI.H>
Link against: sheng.lib
This item is not part of the S60 5th Edition SDK

Class TShgCell

Interface status: deprecated

class TShgCell;

Description

A spreadsheet engine cell.

Members

Defined in TShgCell:


Construction and destruction


TShgCell()

Interface status: deprecated Inherited from: TShgCell

IMPORT_C TShgCell();

Description

Default constructor.


TShgCell(const TCellRef &)

Interface status: deprecated Inherited from: TShgCell

IMPORT_C TShgCell(const TCellRef &aCellRef);

Description

Constructor, specifying a cell reference.

Parameters

const TCellRef &aCellRef

Cell reference

[Top]


Member functions


Coord()const

Interface status: deprecated Inherited from: TShgCell

IMPORT_C TCellRef Coord() const;

Description

Gets the cell reference.

Return value

TCellRef

Cell reference


Type()const

Interface status: deprecated Inherited from: TShgCell

IMPORT_C TType Type() const;

Description

Gets the cell type.

Return value

TShgCell::TType

Cell type


SetInt(TInt32)

Interface status: deprecated Inherited from: TShgCell

IMPORT_C void SetInt(TInt32 aInt);

Description

Sets the cell contents to an integer.

Parameters

TInt32 aInt

New cell value


Int()const

Interface status: deprecated Inherited from: TShgCell

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


SetBool(TBool)

Interface status: deprecated Inherited from: TShgCell

IMPORT_C void SetBool(TBool aBool);

Description

Sets the cell contents to a boolean.

Parameters

TBool aBool

New cell value


Bool()const

Interface status: deprecated Inherited from: TShgCell

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


SetErrorType(TErrorType)

Interface status: deprecated Inherited from: TShgCell

IMPORT_C void SetErrorType(TErrorType aErrorType);

Description

Sets the cell contents to an error.

Parameters

TShgCell::TErrorType aErrorType

New cell value


ErrorType()const

Interface status: deprecated Inherited from: TShgCell

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

TShgCell::TErrorType

Cell value


SetReal(const TReal64 &)

Interface status: deprecated Inherited from: TShgCell

IMPORT_C void SetReal(const TReal64 &aReal);

Description

Sets the cell contents to a real number.

Parameters

const TReal64 &aReal

New cell value


Real()const

Interface status: deprecated Inherited from: TShgCell

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


SetTextTakingOwnership(HBufC *)

Interface status: deprecated Inherited from: TShgCell

IMPORT_C void SetTextTakingOwnership(HBufC *aText);

Description

Sets the cell contents to a string.

The cell takes ownership of the passed string.

Parameters

HBufC16 *aText

New cell value


Text()const

Interface status: deprecated Inherited from: TShgCell

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 TDesC16 &

Cell value


SetFormulaL(CShgFormulaSet *,const TDesC8 &)

Interface status: deprecated Inherited from: TShgCell

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

Description

Parameters

CShgFormulaSet *aFormulaSet

const TDesC8 &aTokenFormula


SetFormulaTakingOwnershipL(CShgFormulaSet *,TDesC8 *)

Interface status: deprecated Inherited from: TShgCell

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

Description

Parameters

CShgFormulaSet *aFormulaSet

TDesC8 *aTokenFormula


CloseFormula(CShgFormulaSet *)

Interface status: deprecated Inherited from: TShgCell

IMPORT_C void CloseFormula(CShgFormulaSet *aFormulaSet);

Description

Parameters

CShgFormulaSet *aFormulaSet


Formula()const

Interface status: deprecated Inherited from: TShgCell

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


Key()const

Interface status: deprecated Inherited from: TShgCell

inline TUint32 Key() const;

Description

Return value

TUint32


Row(TUint32)

Interface status: deprecated Inherited from: TShgCell

static inline TUint32 Row(TUint32 aKey);

Description

Parameters

TUint32 aKey

Return value

TUint32


CoordBitsOfKey()

Interface status: deprecated Inherited from: TShgCell

static inline TUint32 CoordBitsOfKey();

Description

Return value

TUint32


MaximumKey()

Interface status: deprecated Inherited from: TShgCell

static inline TUint32 MaximumKey();

Description

Return value

TUint32


MinimumKeyFromCoord(const TCellRef &)

Interface status: deprecated Inherited from: TShgCell

static inline TUint32 MinimumKeyFromCoord(const TCellRef &aCellRef);

Description

Parameters

const TCellRef &aCellRef

Return value

TUint32


MinimumKeyFromCoord(TInt,TInt)

Interface status: deprecated Inherited from: TShgCell

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

Description

Parameters

TInt aRow

TInt aCol

Return value

TUint32


MaximumKeyFromCoord(const TCellRef &)

Interface status: deprecated Inherited from: TShgCell

static inline TUint32 MaximumKeyFromCoord(const TCellRef &aCellRef);

Description

Parameters

const TCellRef &aCellRef

Return value

TUint32


MaximumKeyFromCoord(TInt,TInt)

Interface status: deprecated Inherited from: TShgCell

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

Description

Parameters

TInt aRow

TInt aCol

Return value

TUint32


ReturnCoord()const

Interface status: deprecated Inherited from: TShgCell

inline TCellRef ReturnCoord() const;

Description

Return value

TCellRef


ReturnType()const

Interface status: deprecated Inherited from: TShgCell

inline TType ReturnType() const;

Description

Return value

TShgCell::TType


IsShadow()const

Interface status: deprecated Inherited from: TShgCell

inline TBool IsShadow() const;

Description

Return value

TBool


IsShadowOf(const TShgCell &)const

Interface status: deprecated Inherited from: TShgCell

inline TBool IsShadowOf(const TShgCell &aRealCell) const;

Description

Parameters

const TShgCell &aRealCell

Return value

TBool


IsTemporarilyReal()const

Interface status: deprecated Inherited from: TShgCell

inline TBool IsTemporarilyReal() const;

Description

Return value

TBool


MakeShadow()

Interface status: deprecated Inherited from: TShgCell

inline void MakeShadow();

Description


MakeTemporarilyReal()

Interface status: deprecated Inherited from: TShgCell

inline void MakeTemporarilyReal();

Description


MakeProperlyReal()

Interface status: deprecated Inherited from: TShgCell

inline void MakeProperlyReal();

Description

[Top]


Member enumerations


Enum TErrorType

Interface status: deprecated Inherited from: TShgCell

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.


Enum TType

Interface status: deprecated Inherited from: TShgCell

TType

Description

Defines cell types.

EBlank

Blank cell.

EInt

Integer cell.

EBool

Boolean cell.

EError

Error cell.

EReal

Real number cell.

EText

Text cell.