Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: SHGAPI.H
Link against: sheng.lib

This item is not part of the S60 3rd Edition SDK for Symbian OS, Feature Pack 2.

Class CShgAdditionalDataIter

class CShgAdditionalDataIter : public CBase;

Description

An iterator over cell additional data objects in a worksheet.

Derivation

Members

Defined in CShgAdditionalDataIter:
CurrentL(), NewL(), NextL(), Reset(), SAdditionalData, ~CShgAdditionalDataIter()

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


Construction and destruction


NewL()

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 *


~CShgAdditionalDataIter()

virtual IMPORT_C ~CShgAdditionalDataIter();

Description

Destructor.

[Top]


Member functions


Reset()

IMPORT_C void Reset();

Description

Resets the iterator to the start of the worksheet.


CurrentL()

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.


NextL()

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.

[Top]


Member structures


Struct SAdditionalData

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.