Class CShgAdditionalDataIter

Interface status:

deprecated

class CShgAdditionalDataIter : public CBase;

Description

An iterator over cell additional data objects in a worksheet.

Derivation

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

• CShgAdditionalDataIter - An iterator over cell additional data objects in a worksheet.

Members

Defined in CShgAdditionalDataIter:

• CurrentL()Gets the iterator's current additional data object.
• NewL(const CShgWorkSheet *)Allocates and constructs a cell additional data objects iterator.
• NextL()Increments the iterator.
• Reset()Resets the iterator to the start of the worksheet.
• SAdditionalDataRepresents an additional data object together with the range to which it applies...
• ~CShgAdditionalDataIter()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...

Interface status:

deprecated

Inherited from: CShgAdditionalDataIter

IMPORT_C static CShgAdditionalDataIter* NewL(const CShgWorkSheet *aWorkSheet);

Description

Allocates and constructs a cell additional data objects iterator.

Parameters

const CShgWorkSheet *aWorkSheet Worksheet to iterate on

Return value

CShgAdditionalDataIter *

Interface status:

deprecated

Inherited from: CShgAdditionalDataIter

IMPORT_C virtual ~CShgAdditionalDataIter();

Description

Destructor.

Interface status:

deprecated

Inherited from: CShgAdditionalDataIter

IMPORT_C void Reset();

Description

Resets the iterator to the start of the worksheet.

Interface status:

deprecated

Inherited from: CShgAdditionalDataIter

IMPORT_C const SAdditionalData* CurrentL();

Description

Gets the iterator's current additional data object.

Return value

const CShgAdditionalDataIter::SAdditionalData * Iterator's current additional data object. This is NULL when the iteration has completed.

Interface status:

deprecated

Inherited from: CShgAdditionalDataIter

IMPORT_C const SAdditionalData* NextL();

Description

Increments the iterator.

Return value

const CShgAdditionalDataIter::SAdditionalData * Incremented iterator's current additional data object. This is NULL when the iteration has completed.

Interface status:

deprecated

struct SAdditionalData;

Description

Represents an additional data object together with the range to which it applies.

Members

Defined in CShgAdditionalDataIter::SAdditionalData:

• iAdditionalDataAdditional data object.
• iRangeRefRange to which additional data applies.

Member data

---

iRangeRef

Interface status:

deprecated

Inherited from: CShgAdditionalDataIter::SAdditionalData

TRangeRef iRangeRef;

Description

Range to which additional data applies.

---

iAdditionalData

Interface status:

deprecated

Inherited from: CShgAdditionalDataIter::SAdditionalData

const CShgCellAdditionalData * iAdditionalData;

Description

Additional data object.