Class TShgCellIter

class TShgCellIter;

Description

An iterator over a range of cells.

The iterator wraps around between the start and end cells.

Members

Defined in TShgCellIter:
Current(), EStartPointFirst, EStartPointLast, SetToFirst(), SetToLast(), TShgCellIter(), TStartPoint, operator++(), operator--()

IMPORT_C TShgCellIter(const CShgWorkSheet *aWorkSheet, const TRangeRef &aRange, TStartPoint aStartPoint=EStartPointFirst);

Description

Constructor.

Parameters

const CShgWorkSheet *aWorkSheet Worksheet containing the cells const TRangeRef &aRange Cell range over which to iterate TStartPoint aStartPoint Starting point for the iterator

IMPORT_C void SetToFirst();

Description

Sets the iterator to the first cell.

IMPORT_C void SetToLast();

Description

Sets the iterator to the last cell.

inline TShgCell *Current();

Description

Gets the iterator's current cell.

Return value

TShgCell * The current cell

IMPORT_C TShgCell *operator++();

Description

Increments the iterator, and then returns the current cell.

Return value

TShgCell * The current cell, after the increment

IMPORT_C TShgCell *operator--();

Description

Decrements the iterator, and then returns the current cell.

Return value

TShgCell * The current cell, after the decrement.

TStartPoint

Description

Flags for the iterator starting point.

EStartPointFirst Start the iterator at the first cell. EStartPointLast Start the iterator at the last cell.