Class TPageRef

class TPageRef;

Description

Encapsulates a page reference.

A page reference is an integer value that can be used to identify a page.

Members

Defined in TPageRef:
ExternalizeL(), InternalizeL(), TPageRef(), TPageRef(), Value(), operator!=(), operator==()

inline TPageRef();

Description

Default constructor.

inline TPageRef(TUint32 aValue);

Description

Constructor that initialises the object to a page reference value.

Parameters

TUint32 aValue Page reference value

inline TBool operator==(TPageRef aRef) const;

Description

Equality operator.

Parameters

TPageRef aRef Page reference against which to compare

Return value

TBool True if aRef refers to the same page as the object, otherwise false.

inline TBool operator!=(TPageRef aRef) const;

Description

Inequality operator.

Parameters

TPageRef aRef Page reference against which to compare

Return value

TBool True if aRef does not refer to the same page as the object, otherwise false.

inline void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises a TPageRef object to a write stream.

Parameters

RWriteStream &aStream Stream to which the object should be externalised.

inline void InternalizeL(RReadStream &aStream);

Description

Internalises a TPageRef object from a read stream.

Parameters

RReadStream &aStream Stream from which the object should be internalised.

inline TUint32 Value() const;

Description

Gets the page reference value.

Return value

TUint32 Page reference value