TRangeRef Class Reference

#include <bacell.h>

Link against: bafl.lib

class TRangeRef

Nested Classes and Structures

TRangeRef::TIter

Public Attributes
TCellRef	iFrom
TCellRef	iTo

Public Member Functions
	TRangeRef()
	TRangeRef(const TCellRef &, const TCellRef &)
	TRangeRef(TInt, TInt, TInt, TInt)
IMPORT_C TBool	Contains(const TCellRef &)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TInt	NoCells()
TInt	NoCols()
TInt	NoRows()
void	SetRange(const TCellRef &, const TCellRef &)
void	SetRange(TInt, TInt, TInt, TInt)
TBool	operator!=(const TRangeRef &)
IMPORT_C TBool	operator==(const TRangeRef &)

Detailed Description

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

Member Attribute Documentation

iFrom

TCellRef

iFrom

The start cell.

iTo

TCellRef

iTo

The end cell.

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.

Parameter	Description
aFrom	The start cell.
aTo	The end cell.

TRangeRef ( TInt, TInt, TInt, TInt )

TRangeRef	(	TInt	aFromRow,
		TInt	aFromCol,
		TInt	aToRow,
		TInt	aToCol
	)	[inline]

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

Parameter	Description
aFromRow	The start row number.
aFromCol	The start column number.
aToRow	The end row number.
aToCol	The end column number.

Member Function Documentation

Contains ( const TCellRef & )

IMPORT_C TBool

Contains

(

const TCellRef &

aCell

)

const

Tests whether the specified cell is contained within the range.

A range includes its outer perimeter.

Parameter	Description
aCell	The cell to be tested.

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

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

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.

Parameter	Description
aStream	Stream to which the object should be externalised.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

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.

Parameter	Description
aStream	Stream from which the object is to be internalised.

NoCells ( )

IMPORT_C TInt

NoCells

(

)

const

Gets the number of cells represented by the range.

Returns: The number of cells.

NoCols ( )

TInt

NoCols

(

)

const [inline]

Gets the number of columns represented by the range.

Returns: The number of columns.

NoRows ( )

TInt

NoRows

(

)

const [inline]

Gets the number of rows represented by the range.

Returns: The number of rows.

SetRange ( const TCellRef &, const TCellRef & )

void	SetRange	(	const TCellRef &	aFrom,
			const TCellRef &	aTo
		)	[inline]

Sets the cell range to the specified cells.

Parameter	Description
aFrom	The start cell for the range.
aTo	The end cell for the range.

SetRange ( TInt, TInt, TInt, TInt )

void	SetRange	(	TInt	aFromRow,
			TInt	aFromCol,
			TInt	aToRow,
			TInt	aToCol
		)	[inline]

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

Parameter	Description
aFromRow	The start row number.
aFromCol	The start column number.
aToRow	The end row number.
aToCol	The end column number.

operator!= ( const TRangeRef & )

TBool

operator!=

(

const TRangeRef &

aRange

)

const [inline]

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

Parameter	Description
aRange	The cell to be compared.

Returns: ETrue, if the start cells are different or the end cells are different.

operator== ( const TRangeRef & )

IMPORT_C TBool

operator==

(

const TRangeRef &

aRange

)

const

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

Parameter	Description
aRange	The cell range to be compared.

Returns: ETrue, if the start cells and the end cells are the same.