Class CShgName

class CShgName : public CBase;

Description

A spreadsheet engine name entry.

A name is a user-specified identifier for particular cells, ranges, or values.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CShgName - A spreadsheet engine name entry.

Members

Defined in CShgName:

• AsTextL(const CShgWorkBook *,TDes &)constGets the name value as a string.
• ECellName refers to a cell.
• EErrorName refers to an item in an error state.
• EFormulaName refers to a formula.
• EIntName refers to an integer.
• EPermanentlyDeletedName refers to an item that has been permanently deleted.
• ERangeName refers to a cell range.
• ERealName refers to a real number.
• ETextName refers to a string.
• Error()constGets the error type, if the value results in an error.
• Formula()constGets the value of a formula type name.
• GetCell(TInt &,TCellRef &)constGets the value of a cell type name.
• GetRange(TInt &,TRangeRef &)constGets the value of a cell range type name.
• Int()constGets the value of an integer type name.
• Name()constGets the name identifier.
• Real()constGets the value of a real number type name.
• TTypeDefines possible name value types.
• Text()constGets the value of a text type name.
• Type()constGets the name value type.
• ~CShgName()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

virtual ~CShgName();

Description

Destructor.

IMPORT_C TPtrC Name() const;

Description

Gets the name identifier.

Return value

IMPORT_C void AsTextL(const CShgWorkBook *aWorkBook, TDes &aDes) const;

Description

Gets the name value as a string.

Where the name value is not a string type, the returned value is an appropriate conversion.

Parameters

IMPORT_C TType Type() const;

Description

Gets the name value type.

Return value

IMPORT_C TInt32 Int() const;

Description

Gets the value of an integer type name.

Return value

IMPORT_C TReal64 Real() const;

Description

Gets the value of a real number type name.

Return value

IMPORT_C TShgCell::TErrorType Error() const;

Description

Gets the error type, if the value results in an error.

Return value

IMPORT_C const TDesC& Text() const;

Description

Gets the value of a text type name.

Return value

IMPORT_C void GetCell(TInt &aWorkSheetNo, TCellRef &aCellRef) const;

Description

Gets the value of a cell type name.

Parameters

IMPORT_C void GetRange(TInt &aWorkSheetNo, TRangeRef &aRangeRef) const;

Description

Gets the value of a cell range type name.

Parameters

IMPORT_C const TDesC8* Formula() const;

Description

Gets the value of a formula type name.

Return value

TType

Description

Defines possible name value types.