Class CShgNameSet

class CShgNameSet : public CBase;

Description

An array of spreadsheet engine names.

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

• CShgNameSet - An array of spreadsheet engine names

Members

Defined in CShgNameSet:
AddNameL(), ChangeNameL(), Count(), DeleteNameL(), EditOperationComplete(), FindName(), FindNameId(), RenameNameL(), RestoreL(), StartEditOperation(), StoreL(), operator[](), ~CShgNameSet()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• CShgName

virtual ~CShgNameSet();

Description

Destructor.

IMPORT_C TStreamId StoreL(CStreamStore &aStore) const;

Description

Stores the name set.

Parameters

CStreamStore &aStore Store to write to

Return value

TStreamId ID of the root stream

IMPORT_C void RestoreL(const CStreamStore &aStore, TStreamId aStreamId);

Description

Restores the name set.

Parameters

const CStreamStore &aStore Store to read from TStreamId aStreamId ID of the root stream

IMPORT_C TShgError AddNameL(const TDesC &aName, const TDesC &aData);

Description

Adds a name to the set.

Parameters

const TDesC &aName Name identifier const TDesC &aData Name value. The function parses the value to discover what the name type is.

Return value

TShgError EShgNameAlreadyExists if the name already exists

IMPORT_C TShgError ChangeNameL(const TDesC &aName, const TDesC &aData);

Description

Changes the value of an existing name.

Parameters

const TDesC &aName Name identifier const TDesC &aData New name value

Return value

TShgError EShgNameDoesNotExist if the name was not found

IMPORT_C TShgError RenameNameL(const TDesC &aOldName, const TDesC &aNewName);

Description

Changes the identifier of an existing name.

Parameters

const TDesC &aOldName Current name identifier const TDesC &aNewName New name identifier

Return value

TShgError EShgNameDoesNotExist if aOldName is not found, or EShgNameAlreadyExists if aNewName is found

IMPORT_C TShgError DeleteNameL(const TDesC &aName);

Description

Deletes a name.

Parameters

const TDesC &aName Name identifier

Return value

TShgError EShgNameDoesNotExist if the name was not found

IMPORT_C TInt32 FindNameId(const TDesC &aName, TBool aIncludePermanentlyDeletedNames=EFalse) const;

Description

Finds a specified name by identifier.

Parameters

const TDesC &aName Name identifier TBool aIncludePermanentlyDeletedNames If true, include permanently deleted names in the search

Return value

TInt32 The index of the found name, or KErrNotFound if not found

IMPORT_C const CShgName *FindName(TInt32 aNameId, TBool aIncludePermanentlyDeletedNames=EFalse) const;

Description

Finds a specified name by index value.

Parameters

TInt32 aNameId Name index TBool aIncludePermanentlyDeletedNames If true, include permanently deleted names in the search

Return value

const CShgName * The found name, or NULL if not found

IMPORT_C TInt Count(TBool aIncludePermanentlyDeletedNames=EFalse) const;

Description

Gets the number of names in the set.

Parameters

TBool aIncludePermanentlyDeletedNames If true, include permanently deleted names in the count

Return value

TInt Number of names in the set

IMPORT_C const CShgName *operator[](TInt aPhysicalIndex) const;

Description

Gets a name by index.

The function panics if the index is out of range.

Parameters

TInt aPhysicalIndex Name index

Return value

const CShgName * Name at index aPhysicalIndex

IMPORT_C void StartEditOperation();

Description

Marks the start of an edit operation.

IMPORT_C void EditOperationComplete();

Description

Marks the completion of an edit operation.