TPageSpec Class Reference

class TPageSpec

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"
Since
5.0
Public Member Functions
TPageSpec()
TPageSpec(TPageOrientation, const TSize &)
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TSizeOrientedPageSize()
IMPORT_C TBooloperator!=(const TPageSpec &)
IMPORT_C TBooloperator==(const TPageSpec &)
Public Member Enumerations
enumTPageOrientation { EPortrait, ELandscape }
Public Attributes
TPageOrientation iOrientation
TSize iPortraitPageSize

Constructor & Destructor Documentation

TPageSpec()

IMPORT_CTPageSpec()

Default constructor.

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

TPageSpec(TPageOrientation, const TSize &)

IMPORT_CTPageSpec(TPageOrientationaOrientation,
const TSize &aSize
)

Constructor with page orientation and size.

Parameters

TPageOrientation aOrientationSpecifies the page orientation.
const TSize & aSizeSpecifies the page size.

Member Functions Documentation

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

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 & aStreamThe write stream.

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

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 & aStreamThe read stream.

OrientedPageSize()

IMPORT_C TSizeOrientedPageSize()const

Gets the oriented page size.

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

operator!=(const TPageSpec &)

IMPORT_C TBooloperator!=(const TPageSpec &aPageSpec)const

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 & aPageSpecPage specification to be compared.

operator==(const TPageSpec &)

IMPORT_C TBooloperator==(const TPageSpec &aPageSpec)const

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 & aPageSpecPage specification to be compared.

Member Enumerations Documentation

Enum TPageOrientation

The available page orientations.

Enumerators

EPortrait

Portrait page orientation

ELandscape

Landscape page orientation

Member Data Documentation

TPageOrientation iOrientation

TPageOrientation iOrientation

The page orientation.

TSize iPortraitPageSize

TSize iPortraitPageSize

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.