Class CShgProtectionIter

Interface status:

deprecated

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()Gets the iterator's current cell range.
• NewL(const CShgWorkSheet *,TBool)Allocates and constructs a protected cells iterator.
• Reset()Resets the iterator to the start of the worksheet.
• operator++()Increments the iterator.
• ~CShgProtectionIter()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: CShgProtectionIter

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

Interface status:

deprecated

Inherited from: CShgProtectionIter

IMPORT_C virtual ~CShgProtectionIter();

Description

Destructor.

Interface status:

deprecated

Inherited from: CShgProtectionIter

IMPORT_C void Reset();

Description

Resets the iterator to the start of the worksheet.

Interface status:

deprecated

Inherited from: CShgProtectionIter

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.

Interface status:

deprecated

Inherited from: CShgProtectionIter

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.