Class TPageSpec

TPageSpec

Support

Supported from 5.0

Description

Page specification for a print operation.

The page specification consists of the page orientation and the page size in twips or pixels. By default, the page orientation is portrait. When using landscape orientation, the left hand side of the page becomes the top.

Defined in TPageSpec:
ELandscape, EPortrait, ExternalizeL(), InternalizeL(), OrientedPageSize(), TPageOrientation, TPageSpec(), iOrientation, iPortraitPageSize, operator!=(), operator==()

TPageSpec();

Description

Default constructor.

Initialises the page orientation to portrait and the page height and width to zero.

TPageSpec(TPageOrientation aOrientation,const TSize& aSize);

Description

Constructor with page orientation and size.

Parameters

TPageOrientation aOrientation Specifies the page orientation. const TSize& aSize Specifies the page size.

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises the page specification object to a write stream.

The presence of this function means that the standard templated stream operator<<(), defined in s32strm.h, is available to externalise objects of this class.

Parameters

RWriteStream& aStream The write stream.

void InternalizeL(RReadStream& aStream);

Description

Internalises a page specification object from a read stream.

The presence of this function means that the standard templated stream operator>>(), defined in s32strm.h, is available to internalise objects of this class.

Parameters

RReadStream& aStream The read stream.

TBool operator==(const TPageSpec& aPageSpec) const;

Description

Equality operator.

This operator compares page specifications for equality. Two page specifications are equal if both their orientations and portrait page sizes are equal.

Parameters

const TPageSpec& aPageSpec Page specification to be compared.

Return value

TBool True, if the page specifications are equal; false, otherwise.

TBool operator!=(const TPageSpec& aPageSpec) const;

Description

Inequality operator.

This operator compares two page specifications for inequality. Two page specifications are unequal if one or both of their orientations and portrait page sizes differ.

Parameters

const TPageSpec& aPageSpec Page specification to be compared.

Return value

TBool True, if the page specifications differ; false, otherwise.

TSize OrientedPageSize() const;

Description

Gets the oriented page size.

The oriented page size is the absolute width and height of the page, respecting the page orientation.

Return value

TSize The oriented page size (in pixels or twips).

TPageOrientation

Description

The available page orientations.

EPortrait Portrait page orientation ELandscape Landscape page orientation

TPageOrientation iOrientation

Description

The page orientation.

TSize iPortraitPageSize

Description

The width and height of the page in portrait orientation in twips or pixels.

Note that OrientedPageSize() returns the width and height in reverse order for a landscape portrait.