Class TPageRef

TPageRef

Support

Supported from 5.0

Description

Encapsulates a page reference.

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

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

TPageRef()

Description

Default constructor.

TPageRef(TUint32 aValue);

Description

Constructor that initialises the object to a page reference value.

Parameters

TUint32 aValue Page reference value

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.

void InternalizeL(RReadStream& aStream);

Description

Internalises a TPageRef object from a read stream.

Parameters

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

TUint32 Value() const;

Description

Gets the page reference value.

Return value

TUint32 Page reference value

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.

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.