Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
TPageSpec Class Reference

Page specification for a print operation. More...

#include <gdi.h>

Public Types

enum  TPageOrientation { EPortrait , ELandscape }
 The available page orientations. More...
 

Public Member Functions

IMPORT_C TPageSpec ()
 Default constructor.
 
IMPORT_C TPageSpec (TPageOrientation aOrientation, const TSize &aSize)
 Constructor with page orientation and size.
 
IMPORT_C void InternalizeL (RReadStream &aStream)
 Internalises a page specification object from a read stream.
 
IMPORT_C void ExternalizeL (RWriteStream &aStream) const
 Externalises the page specification object to a write stream.
 
IMPORT_C TSize OrientedPageSize () const
 Gets the oriented page size.
 
IMPORT_C TBool operator== (const TPageSpec &aPageSpec) const
 Equality operator.
 
IMPORT_C TBool operator!= (const TPageSpec &aPageSpec) const
 Inequality operator.
 

Public Attributes

TSize iPortraitPageSize
 The width and height of the page in portrait orientation in twips or pixels.
 
TPageOrientation iOrientation
 The page orientation.
 

Detailed 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"

Since
5.0
API status
Published to all clients. Released API.

Definition at line 3757 of file gdi.h.

Member Enumeration Documentation

◆ TPageOrientation

The available page orientations.

Enumerator
EPortrait 

Portrait page orientation.

ELandscape 

Landscape page orientation.

Definition at line 3761 of file gdi.h.

Constructor & Destructor Documentation

◆ TPageSpec() [1/2]

IMPORT_C TPageSpec::TPageSpec ( )

Default constructor.

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

(generated from Symbian Developer Library)

◆ TPageSpec() [2/2]

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

Constructor with page orientation and size.

Parameters
aOrientationSpecifies the page orientation.
aSizeSpecifies the page size.

(generated from Symbian Developer Library)

Member Function Documentation

◆ ExternalizeL()

IMPORT_C void TPageSpec::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
aStreamThe write stream.

(generated from Symbian Developer Library)

◆ InternalizeL()

IMPORT_C void TPageSpec::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
aStreamThe read stream.

(generated from Symbian Developer Library)

◆ operator!=()

IMPORT_C TBool TPageSpec::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
aPageSpecPage specification to be compared.

(generated from Symbian Developer Library)

◆ operator==()

IMPORT_C TBool TPageSpec::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
aPageSpecPage specification to be compared.

(generated from Symbian Developer Library)

◆ OrientedPageSize()

IMPORT_C TSize TPageSpec::OrientedPageSize ( ) const

Gets the oriented page size.

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

(generated from Symbian Developer Library)

Member Data Documentation

◆ iOrientation

TPageOrientation TPageSpec::iOrientation

The page orientation.

Definition at line 3784 of file gdi.h.

◆ iPortraitPageSize

TSize TPageSpec::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.

Definition at line 3782 of file gdi.h.


The documentation for this class was generated from the following files: