Class CShgAdditionalDataIter

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(), NewL(), NextL(), Reset(), SAdditionalData, ~CShgAdditionalDataIter()

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

static IMPORT_C 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 *

virtual IMPORT_C ~CShgAdditionalDataIter();

Description

Destructor.

IMPORT_C void Reset();

Description

Resets the iterator to the start of the worksheet.

IMPORT_C const SAdditionalData *CurrentL();

Description

Gets the iterator's current additional data object.

Return value

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

IMPORT_C const SAdditionalData *NextL();

Description

Increments the iterator.

Return value

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

struct SAdditionalData;

Description

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

Members

Defined in CShgAdditionalDataIter::SAdditionalData:
iAdditionalData, iRangeRef

Member data

---

iRangeRef

TRangeRef iRangeRef;

Description

Range to which additional data applies.

---

iAdditionalData

const CShgCellAdditionalData * iAdditionalData;

Description

Additional data object.