#include <gdi.h>
| class TPageSpec |
| Public Attributes | |
|---|---|
| TPageOrientation | iOrientation |
| TSize | iPortraitPageSize |
| Public Member Enumerations | |
|---|---|
| enum | TPageOrientation { EPortrait, ELandscape } |
| 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 &) |
Page specification for a print operation.
| 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.
| IMPORT_C | TPageSpec | ( | ) |
Default constructor.
Initialises the page orientation to portrait and the page height and width to zero.
| IMPORT_C | TPageSpec | ( | TPageOrientation | aOrientation, |
| const TSize & | aSize | |||
| ) | ||||
Constructor with page orientation and size.
| Parameter | Description |
|---|---|
| aOrientation | Specifies the page orientation. |
| aSize | Specifies the page size. |
| 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.
| Parameter | Description |
|---|---|
| aStream | The write stream. |
| 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.
| Parameter | Description |
|---|---|
| aStream | The read stream. |
| 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.
Returns: The oriented page size (in pixels or twips).
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.
| Parameter | Description |
|---|---|
| aPageSpec | Page specification to be compared. |
Returns: ETrue, if the page specifications differ; EFalse, otherwise.
Equality operator.
This operator compares page specifications for equality. Two page specifications are equal if both their orientations and portrait page sizes are equal.
| Parameter | Description |
|---|---|
| aPageSpec | Page specification to be compared. |
Returns: ETrue, if the page specifications are equal; EFalse, otherwise.