Class TRangeRef

class TRangeRef;

Description

Identifies a range of cells by start and end cell references. The range is inclusive of both the start and end cells.

Members

Defined in TRangeRef:

• Contains(const TCellRef &)constTests whether the specified cell is contained within the range.
• ExternalizeL(RWriteStream &)constExternalises an object of this class to a write stream.
• InternalizeL(RReadStream &)Internalises an object of this class from a read stream.
• NoCells()constGets the number of cells represented by the range.
• NoCols()constGets the number of columns represented by the range.
• NoRows()constGets the number of rows represented by the range.
• SetRange(TInt,TInt,TInt,TInt)Sets the cell range to the specified start row and column, and end row and colum...
• SetRange(const TCellRef &,const TCellRef &)Sets the cell range to the specified cells.
• TIter
• TRangeRef()Default constructor.
• TRangeRef(TInt,TInt,TInt,TInt)Constructor taking a start row and start column number, and an end row and end c...
• TRangeRef(const TCellRef &,const TCellRef &)Constructor taking a start and end cell.
• iFromThe start cell.
• iToThe end cell.
• operator!=(const TRangeRef &)constCompares this cell range with the specified cell range for inequality.
• operator==(const TRangeRef &)constCompares this cell range with the specified cell range for equality.

See also:

• TCellRefIdentifies a cell by row and column number.

inline TRangeRef();

Description

Default constructor.

The object's start cell and end cell are undefined.

inline TRangeRef(const TCellRef &aFrom, const TCellRef &aTo);

Description

Constructor taking a start and end cell.

Parameters

const TCellRef &aFrom The start cell. const TCellRef &aTo The end cell.

inline TRangeRef(TInt aFromRow, TInt aFromCol, TInt aToRow, TInt aToCol);

Description

Constructor taking a start row and start column number, and an end row and end column number.

Parameters

TInt aFromRow The start row number. TInt aFromCol The start column number. TInt aToRow The end row number. TInt aToCol The end column number.

IMPORT_C TBool operator==(const TRangeRef &aRange) const;

Description

Compares this cell range with the specified cell range for equality.

Parameters

const TRangeRef &aRange The cell range to be compared.

Return value

TBool ETrue, if the start cells and the end cells are the same.

inline TBool operator!=(const TRangeRef &aRange) const;

Description

Compares this cell range with the specified cell range for inequality.

Parameters

const TRangeRef &aRange The cell to be compared.

Return value

TBool ETrue, if the start cells are different or the end cells are different.

inline void SetRange(const TCellRef &aFrom, const TCellRef &aTo);

Description

Sets the cell range to the specified cells.

Parameters

const TCellRef &aFrom The start cell for the range. const TCellRef &aTo The end cell for the range.

inline void SetRange(TInt aFromRow, TInt aFromCol, TInt aToRow, TInt aToCol);

Description

Sets the cell range to the specified start row and column, and end row and column.

Parameters

TInt aFromRow The start row number. TInt aFromCol The start column number. TInt aToRow The end row number. TInt aToCol The end column number.

inline TInt NoRows() const;

Description

Gets the number of rows represented by the range.

Return value

TInt The number of rows.

inline TInt NoCols() const;

Description

Gets the number of columns represented by the range.

Return value

TInt The number of columns.

IMPORT_C TInt NoCells() const;

Description

Gets the number of cells represented by the range.

Return value

TInt The number of cells.

IMPORT_C TBool Contains(const TCellRef &aCell) const;

Description

Tests whether the specified cell is contained within the range.

A range includes its outer perimeter.

Parameters

const TCellRef &aCell The cell to be tested.

Return value

TBool ETrue, if the specified cell is contained within the range; EFalse, otherwise.

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises an object of this class from a read stream.

The presence of this function means that the standard templated operator>>(RReadStream &,T &) can be used to internalise objects of this class.

Note that the function has assignment semantics. It replaces the old value of the object with a new value read from the read stream.

Parameters

RReadStream &aStream Stream from which the object is to be internalised.

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises an object of this class to a write stream.

The presence of this function means that the standard templated operator<<(RWriteStream &,const T &) can be used to externalise objects of this class.

Parameters

RWriteStream &aStream Stream to which the object should be externalised.

class TIter;

Description

Members

Defined in TRangeRef::TIter:

• InRange()const
• TIter(const TRangeRef &)
• iCurrent
• operator++()

Construction and destruction

---

TIter(const TRangeRef &)

IMPORT_C TIter(const TRangeRef &aRangeRef);

Description

Parameters

const TRangeRef &aRangeRef

Member functions

---

operator++()

IMPORT_C TBool operator++();

Description

Return value

TBool

---

InRange()const

inline TBool InRange() const;

Description

Return value

TBool

Member data

---

iCurrent

TCellRef iCurrent;

Description

TCellRef iFrom;

Description

The start cell.

TCellRef iTo;

Description

The end cell.