Class TShgCellRef

class TShgCellRef;

Description

A cell reference, specifying a cell's row and column, in either absolute or relative terms.

Members

Defined in TShgCellRef:
AsCellRef(), Col(), EAbsoluteIndicator, Externalize(), Externalize(), Internalize(), IsAbs(), IsColAbs(), IsRowAbs(), IsWorkSheetExplicit(), Row(), SetCol(), SetColAbs(), SetColRel(), SetRow(), SetRowAbs(), SetRowCol(), SetRowRel(), SetWorkSheetExplicit(), SetWorkSheetNo(), SetWorkSheetNotExplicit(), TShgCellRef(), TShgCellRef(), TShgCellRef(), WorkSheetNo(), anonymous

inline TShgCellRef();

Description

Default constructor.

inline TShgCellRef(TInt aRow, TInt aCol, TInt aWorkSheetNo);

Description

Constructor, specifying absolute cell position.

Parameters

TInt aRow Cell row TInt aCol Cell column TInt aWorkSheetNo Cell worksheet

inline TShgCellRef(const TShgCellRef &aCell);

Description

Constructor, copying another cell reference.

Parameters

const TShgCellRef &aCell Cell reference to copy

inline void SetRow(TInt aRow);

Description

Sets the cell row.

Parameters

TInt aRow Cell row

inline TInt Row() const;

Description

Gets the cell row.

Return value

TInt Cell row

inline void SetCol(TInt aCol);

Description

Sets the cell column.

Parameters

TInt aCol Cell column

inline TInt Col() const;

Description

Gets the cell column.

Return value

TInt Cell column

inline void SetRowCol(TInt aRow, TInt aCol);

Description

Sets the cell row and column.

Parameters

TInt aRow Cell row TInt aCol Cell column

inline void SetWorkSheetNo(TInt aWorkSheetNo);

Description

Sets the cell worksheet.

Parameters

TInt aWorkSheetNo Cell worksheet

inline TInt WorkSheetNo() const;

Description

Gets the cell worksheet.

Return value

TInt Cell worksheet

inline TCellRef AsCellRef() const;

Description

Gets the cell reference converted to a Grid API cell reference.

Return value

TCellRef Grid API cell reference

inline TBool IsAbs() const;

Description

Tests if the reference is absolute.

Return value

TBool True if the reference is absolute

inline TBool IsRowAbs() const;

Description

Tests if the row setting is absolute.

Return value

TBool True if the row setting is absolute

inline TBool IsColAbs() const;

Description

Tests if the column setting is absolute.

Return value

TBool True if the column setting is absolute

inline void SetRowRel();

Description

Sets the row setting to be relative.

inline void SetRowAbs();

Description

Sets the row setting to be absolute.

inline void SetColRel();

Description

Sets the column setting to be relative.

inline void SetColAbs();

Description

Sets the column setting to be absolute.

inline void SetWorkSheetExplicit();

Description

Sets a flag indicating that a worksheet has been set for the cell.

inline void SetWorkSheetNotExplicit();

Description

Sets a flag indicating that a worksheet has not been set for the cell.

inline TBool IsWorkSheetExplicit() const;

Description

Tests if a worksheet has been set for the cell.

Return value

TBool True if a worksheet has been set for the cell

IMPORT_C void Externalize(CBufBase *aBuf) const;

Description

Externalises the object to a dynamic buffer.

Parameters

CBufBase *aBuf Buffer to write to.

IMPORT_C void Externalize(TDes8 &aDes) const;

Description

Externalises the object to a descriptor.

Parameters

TDes8 &aDes Descriptor to write to

IMPORT_C TInt Internalize(const TUint8 *aPtr);

Description

Internalises the object from raw memory.

Parameters

const TUint8 *aPtr Pointer to memory to read

Return value

TInt Object memory size

n/a

Description

Constant definition.

EAbsoluteIndicator Character to use in string references to indicate an absolute reference.