Class TPageSpec

class TPageSpec;

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. "gdi.lib"

Members

Defined in TPageSpec:

• ELandscapeLandscape page orientation
• EPortraitPortrait page orientation
• ExternalizeL(RWriteStream &)constExternalises the page specification object to a write stream.
• InternalizeL(RReadStream &)Internalises a page specification object from a read stream.
• OrientedPageSize()constGets the oriented page size.
• TPageOrientationThe available page orientations.
• TPageSpec()Default constructor.
• TPageSpec(TPageOrientation,const TSize &)Constructor with page orientation and size.
• iOrientationThe page orientation.
• iPortraitPageSizeThe width and height of the page in portrait orientation in twips or pixels.
• operator!=(const TPageSpec &)constInequality operator.
• operator==(const TPageSpec &)constEquality operator.

IMPORT_C TPageSpec();

Description

Default constructor.

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

IMPORT_C TPageSpec(TPageOrientation aOrientation, const TSize &aSize);

Description

Constructor with page orientation and size.

Parameters

IMPORT_C 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>>(RReadStream &,T &), defined in s32strm.h, is available to internalise objects of this class.

Parameters

IMPORT_C 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<<(RWriteStream &,const T &), defined in s32strm.h, is available to externalise objects of this class.

Parameters

IMPORT_C 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

IMPORT_C 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

Return value

IMPORT_C 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

Return value

TPageOrientation

Description

The available page orientations.

TSize iPortraitPageSize;

Description

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

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

TPageOrientation iOrientation;

Description

The page orientation.