TCellRef Class Reference

#include <bacell.h>

Link against: bafl.lib

class TCellRef
Public Attributes
TInt iCol
TInt iRow
Public Member Functions
TCellRef()
TCellRef(TInt, TInt)
voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C voidOffset(TInt, TInt)
TBool operator!=(const TCellRef &)
TCellRef &operator+=(const TCellRef &)
TCellRef &operator-=(const TCellRef &)
TBool operator==(const TCellRef &)

Detailed Description

Identifies a cell by row and column number.

Member Attribute Documentation

iCol

TInt iCol

The column number.

iRow

TInt iRow

The row number.

Constructor & Destructor Documentation

TCellRef ( )

TCellRef()[inline]

Default constructor.

The object's row and column number are undefined.

TCellRef ( TInt, TInt )

TCellRef(TIntaRow,
TIntaCol
)[inline]

Constructor taking a row and column number.

ParameterDescription
aRowThe row number.
aColThe column number.

Member Function Documentation

ExternalizeL ( RWriteStream & )

voidExternalizeL(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.

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

ParameterDescription
aStreamStream from which the object is to be internalised.

Offset ( TInt, TInt )

IMPORT_C voidOffset(TIntaRowOffset,
TIntaColOffset
)

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

ParameterDescription
aRowOffsetThe row number to be added. The value may be positive, zero or negative.
aColOffsetThe 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.

ParameterDescription
aCellThe cell to be compared.

Returns: ETrue, if the row numbers are different or the column numbers are different.

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.

ParameterDescription
aCellThe cell to be added.

Returns: A reference to this cell object.

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.

ParameterDescription
aCellThe cell to be subtracted.

Returns: A reference to this cell object.

operator== ( const TCellRef & )

TBool operator==(const TCellRef &aCell)const [inline]

Compares this cell with the specified cell for equality.

ParameterDescription
aCellThe cell to be compared.

Returns: ETrue, if the row numbers are the same and column numbers are the same.