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 CShgNameSet

Interface status: deprecated

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

Members

Defined in CShgNameSet:

Inherited from CBase:

See also:


Construction and destruction


~CShgNameSet()

Interface status: deprecated Inherited from: CShgNameSet

virtual ~CShgNameSet();

Description

Destructor.

[Top]


Member functions


StoreL(CStreamStore &)const

Interface status: deprecated Inherited from: CShgNameSet

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


RestoreL(const CStreamStore &,TStreamId)

Interface status: deprecated Inherited from: CShgNameSet

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


AddNameL(const TDesC &,const TDesC &)

Interface status: deprecated Inherited from: CShgNameSet

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

Description

Adds a name to the set.

Parameters

const TDesC16 &aName

Name identifier

const TDesC16 &aData

Name value. The function parses the value to discover what the name type is.

Return value

TShgError

EShgNameAlreadyExists if the name already exists


ChangeNameL(const TDesC &,const TDesC &)

Interface status: deprecated Inherited from: CShgNameSet

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

Description

Changes the value of an existing name.

Parameters

const TDesC16 &aName

Name identifier

const TDesC16 &aData

New name value

Return value

TShgError

EShgNameDoesNotExist if the name was not found


RenameNameL(const TDesC &,const TDesC &)

Interface status: deprecated Inherited from: CShgNameSet

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

Description

Changes the identifier of an existing name.

Parameters

const TDesC16 &aOldName

Current name identifier

const TDesC16 &aNewName

New name identifier

Return value

TShgError

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


DeleteNameL(const TDesC &)

Interface status: deprecated Inherited from: CShgNameSet

IMPORT_C TShgError DeleteNameL(const TDesC &aName);

Description

Deletes a name.

Parameters

const TDesC16 &aName

Name identifier

Return value

TShgError

EShgNameDoesNotExist if the name was not found


FindNameId(const TDesC &,TBool)const

Interface status: deprecated Inherited from: CShgNameSet

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

Description

Finds a specified name by identifier.

Parameters

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


FindName(TInt32,TBool)const

Interface status: deprecated Inherited from: CShgNameSet

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


Count(TBool)const

Interface status: deprecated Inherited from: CShgNameSet

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


operator[](TInt)const

Interface status: deprecated Inherited from: CShgNameSet

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


StartEditOperation()

Interface status: deprecated Inherited from: CShgNameSet

IMPORT_C void StartEditOperation();

Description

Marks the start of an edit operation.


EditOperationComplete()

Interface status: deprecated Inherited from: CShgNameSet

IMPORT_C void EditOperationComplete();

Description

Marks the completion of an edit operation.