Class CShgProtectionIter

class CShgProtectionIter : public CBase;

Description

An iterator over the protected or unprotected cell ranges in a worksheet.

Derivation

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

• CShgProtectionIter - An iterator over the protected or unprotected cell ranges in a worksheet

Members

Defined in CShgProtectionIter:
Current(), NewL(), Reset(), operator++(), ~CShgProtectionIter()

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

static IMPORT_C CShgProtectionIter *NewL(const CShgWorkSheet *aWorkSheet, TBool aProtectionSetting);

Description

Allocates and constructs a protected cells iterator.

Parameters

const CShgWorkSheet *aWorkSheet Worksheet to iterate on TBool aProtectionSetting If true, include only protected cells in the iteration; if false, include only unprotected cells in the iteration

Return value

CShgProtectionIter * New protected cells iterator

virtual IMPORT_C ~CShgProtectionIter();

Description

Destructor.

IMPORT_C void Reset();

Description

Resets the iterator to the start of the worksheet.

IMPORT_C const TRangeRef *Current();

Description

Gets the iterator's current cell range.

Return value

const TRangeRef * Iterator's current cell range. This is NULL when the iteration has completed.

IMPORT_C const TRangeRef *operator++();

Description

Increments the iterator.

Return value

const TRangeRef * Incremented iterator's current cell range. This is NULL when the iteration has completed.