Collapse all Symbian^3 Product Developer Library

TCellRef Class Reference

class TCellRef

Identifies a cell by row and column number.

Public Member Functions
	TCellRef()
	TCellRef(TInt, TInt)
void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C void	Offset(TInt, TInt)
TBool	operator!=(const TCellRef &)
TCellRef &	operator+=(const TCellRef &)
TCellRef &	operator-=(const TCellRef &)
TBool	operator==(const TCellRef &)

Public Attributes
TInt	iCol
TInt	iRow

Constructor & Destructor Documentation

TCellRef()

TCellRef

(

)

[inline]

Default constructor.

The object's row and column number are undefined.

TCellRef(TInt, TInt)

TCellRef	(	TInt	aRow,
		TInt	aCol
	)	[inline]

Constructor taking a row and column number.

Parameters

TInt aRow	The row number.
TInt aCol	The column number.

Member Functions Documentation

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const [inline]

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 & 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.

Parameters

RReadStream & aStream

Stream from which the object is to be internalised.

Offset(TInt, TInt)

IMPORT_C void	Offset	(	TInt	aRowOffset,
			TInt	aColOffset
		)

Adds the specified row and column numbers to this cell's row and column values.

Parameters

TInt aRowOffset	The row number to be added. The value may be positive, zero or negative.
TInt aColOffset	The column number to be added. The value may be positive, zero or negative.

operator!=(const TCellRef &)

TBool

operator!=

(

const TCellRef &

aCell

)

const [inline]

Compares this cell with the specified cell for inequality.

Parameters

const TCellRef & aCell

The cell to be compared.

operator+=(const TCellRef &)

TCellRef &

operator+=

(

const TCellRef &

aCell

)

[inline]

Adds the specified cell to this cell.

Addition is the process of adding the specified cell's row and column numbers to this cell's row and column numbers respectively.

Parameters

const TCellRef & aCell

The cell to be added.

operator-=(const TCellRef &)

TCellRef &

operator-=

(

const TCellRef &

aCell

)

[inline]

Subtracts the specified cell from this cell.

Subtraction is the process of subtracting the specified cell's row and column numbers from this cell's row and column numbers respectively.

Parameters

const TCellRef & aCell

The cell to be subtracted.

operator==(const TCellRef &)

TBool

operator==

(

const TCellRef &

aCell

)

const [inline]

Compares this cell with the specified cell for equality.

Parameters

const TCellRef & aCell

The cell to be compared.

Member Data Documentation

TInt iCol

TInt

iCol

The column number.

TInt iRow

TInt

iRow

The row number.