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()constGets the cell reference converted to a Grid API cell reference.
• Col()constGets the cell column.
• EAbsoluteIndicatorCharacter to use in string references to indicate an absolute reference.
• Externalize(CBufBase *)constExternalises the object to a dynamic buffer.
• Externalize(TDes8 &)constExternalises the object to a descriptor.
• Internalize(const TUint8 *)Internalises the object from raw memory.
• IsAbs()constTests if the reference is absolute.
• IsColAbs()constTests if the column setting is absolute.
• IsRowAbs()constTests if the row setting is absolute.
• IsWorkSheetExplicit()constTests if a worksheet has been set for the cell.
• Row()constGets the cell row.
• SetCol(TInt)Sets the cell column.
• SetColAbs()Sets the column setting to be absolute.
• SetColRel()Sets the column setting to be relative.
• SetRow(TInt)Sets the cell row.
• SetRowAbs()Sets the row setting to be absolute.
• SetRowCol(TInt,TInt)Sets the cell row and column.
• SetRowRel()Sets the row setting to be relative.
• SetWorkSheetExplicit()Sets a flag indicating that a worksheet has been set for the cell.
• SetWorkSheetNo(TInt)Sets the cell worksheet.
• SetWorkSheetNotExplicit()Sets a flag indicating that a worksheet has not been set for the cell.
• TShgCellRef()Default constructor.
• TShgCellRef(TInt,TInt,TInt)Constructor, specifying absolute cell position.
• TShgCellRef(const TShgCellRef &)Constructor, copying another cell reference.
• WorkSheetNo()constGets the cell worksheet.
• anonymousConstant definition.

inline TShgCellRef();

Description

Default constructor.

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

Description

Constructor, specifying absolute cell position.

Parameters

inline TShgCellRef(const TShgCellRef &aCell);

Description

Constructor, copying another cell reference.

Parameters

inline void SetRow(TInt aRow);

Description

Sets the cell row.

Parameters

inline TInt Row() const;

Description

Gets the cell row.

Return value

inline void SetCol(TInt aCol);

Description

Sets the cell column.

Parameters

inline TInt Col() const;

Description

Gets the cell column.

Return value

inline void SetRowCol(TInt aRow, TInt aCol);

Description

Sets the cell row and column.

Parameters

inline void SetWorkSheetNo(TInt aWorkSheetNo);

Description

Sets the cell worksheet.

Parameters

inline TInt WorkSheetNo() const;

Description

Gets the cell worksheet.

Return value

inline TCellRef AsCellRef() const;

Description

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

Return value

inline TBool IsAbs() const;

Description

Tests if the reference is absolute.

Return value

inline TBool IsRowAbs() const;

Description

Tests if the row setting is absolute.

Return value

inline TBool IsColAbs() const;

Description

Tests if the column setting is absolute.

Return value

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

IMPORT_C void Externalize(CBufBase *aBuf) const;

Description

Externalises the object to a dynamic buffer.

Parameters

IMPORT_C void Externalize(TDes8 &aDes) const;

Description

Externalises the object to a descriptor.

Parameters

IMPORT_C TInt Internalize(const TUint8 *aPtr);

Description

Internalises the object from raw memory.

Parameters

Return value

n/a

Description

Constant definition.