TRangeRef Class Reference

class TRangeRef

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

Nested Classes and Structures

Public Member Functions
TRangeRef()
TRangeRef(const TCellRef &, const TCellRef &)
TRangeRef(TInt, TInt, TInt, TInt)
IMPORT_C TBoolContains(const TCellRef &)
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TIntNoCells()
TInt NoCols()
TInt NoRows()
voidSetRange(const TCellRef &, const TCellRef &)
voidSetRange(TInt, TInt, TInt, TInt)
TBool operator!=(const TRangeRef &)
IMPORT_C TBooloperator==(const TRangeRef &)
Public Attributes
TCellRef iFrom
TCellRef iTo

Constructor & Destructor Documentation

TRangeRef()

TRangeRef()[inline]

Default constructor.

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

TRangeRef(const TCellRef &, const TCellRef &)

TRangeRef(const TCellRef &aFrom,
const TCellRef &aTo
)[inline]

Constructor taking a start and end cell.

Parameters

const TCellRef & aFromThe start cell.
const TCellRef & aToThe end cell.

TRangeRef(TInt, TInt, TInt, TInt)

TRangeRef(TIntaFromRow,
TIntaFromCol,
TIntaToRow,
TIntaToCol
)[inline]

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

Parameters

TInt aFromRowThe start row number.
TInt aFromColThe start column number.
TInt aToRowThe end row number.
TInt aToColThe end column number.

Member Functions Documentation

Contains(const TCellRef &)

IMPORT_C TBoolContains(const TCellRef &aCell)const

Tests whether the specified cell is contained within the range.

A range includes its outer perimeter.

Parameters

const TCellRef & aCellThe cell to be tested.

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises an object of this class to a write stream.

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

Parameters

RWriteStream & aStreamStream to which the object should be externalised.

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises an object of this class from a read stream.

The presence of this function means that the standard templated operator>>() 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 & aStreamStream from which the object is to be internalised.

NoCells()

IMPORT_C TIntNoCells()const

Gets the number of cells represented by the range.

NoCols()

TInt NoCols()const [inline]

Gets the number of columns represented by the range.

NoRows()

TInt NoRows()const [inline]

Gets the number of rows represented by the range.

SetRange(const TCellRef &, const TCellRef &)

voidSetRange(const TCellRef &aFrom,
const TCellRef &aTo
)[inline]

Sets the cell range to the specified cells.

Parameters

const TCellRef & aFromThe start cell for the range.
const TCellRef & aToThe end cell for the range.

SetRange(TInt, TInt, TInt, TInt)

voidSetRange(TIntaFromRow,
TIntaFromCol,
TIntaToRow,
TIntaToCol
)[inline]

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

Parameters

TInt aFromRowThe start row number.
TInt aFromColThe start column number.
TInt aToRowThe end row number.
TInt aToColThe end column number.

operator!=(const TRangeRef &)

TBool operator!=(const TRangeRef &aRange)const [inline]

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

Parameters

const TRangeRef & aRangeThe cell to be compared.

operator==(const TRangeRef &)

IMPORT_C TBooloperator==(const TRangeRef &aRange)const

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

Parameters

const TRangeRef & aRangeThe cell range to be compared.

Member Data Documentation

TCellRef iFrom

TCellRef iFrom

The start cell.

TCellRef iTo

TCellRef iTo

The end cell.