Collapse all Symbian^3 Application Developer Library

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 void	ExternalizeL ( RWriteStream &)
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TSize	OrientedPageSize ()
IMPORT_C TBool	operator!= (const TPageSpec &)
IMPORT_C TBool	operator== (const TPageSpec &)

Public Member Enumerations
enum	TPageOrientation { EPortrait , ELandscape }

Public Attributes
TPageOrientation	iOrientation
TSize	iPortraitPageSize

Constructor & Destructor Documentation

TPageSpec()

IMPORT_C

TPageSpec

(

)

Default constructor.

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

TPageSpec(TPageOrientation, const TSize &)

IMPORT_C	TPageSpec	(	TPageOrientation	aOrientation,
			const TSize &	aSize
		)

Constructor with page orientation and size.

Parameters

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

Member Functions Documentation

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

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 & aStream

The write stream.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

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 & aStream

The read stream.

OrientedPageSize()

IMPORT_C TSize

OrientedPageSize

(

)

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 TBool

operator!=

(

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 & aPageSpec

Page specification to be compared.

operator==(const TPageSpec &)

IMPORT_C TBool

operator==

(

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 & aPageSpec

Page 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.