Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: BACELL.H
Link against: bafl.lib

Class TCellRef

class TCellRef;

Description

Identifies a cell by row and column number.

Members

Defined in TCellRef:
ExternalizeL(), InternalizeL(), Offset(), TCellRef(), TCellRef(), iCol, iRow, operator!=(), operator+=(), operator-=(), operator==()


Construction and destruction


TCellRef()

inline TCellRef();

Description

Default constructor.

The object's row and column number are undefined.


TCellRef()

inline TCellRef(TInt aRow, TInt aCol);

Description

Constructor taking a row and column number.

Parameters

TInt aRow

The row number.

TInt aCol

The column number.

[Top]


Member functions


operator==()

inline TBool operator==(const TCellRef &aCell) const;

Description

Compares this cell with the specified cell for equality.

Parameters

const TCellRef &aCell

The cell to be compared.

Return value

TBool

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


operator!=()

inline TBool operator!=(const TCellRef &aCell) const;

Description

Compares this cell with the specified cell for inequality.

Parameters

const TCellRef &aCell

The cell to be compared.

Return value

TBool

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


operator+=()

inline TCellRef &operator+=(const TCellRef &aCell);

Description

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.

Return value

TCellRef &

A reference to this cell object.


operator-=()

inline TCellRef &operator-=(const TCellRef &aCell);

Description

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.

Return value

TCellRef &

A reference to this cell object.


Offset()

IMPORT_C void Offset(TInt aRowOffset, TInt aColOffset);

Description

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.


InternalizeL()

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


ExternalizeL()

inline 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<<() can be used to externalise objects of this class.

Parameters

RWriteStream &aStream

Stream to which the object should be externalised.

[Top]


Member data


iRow

TInt iRow;

Description

The row number.


iCol

TInt iCol;

Description

The column number.