Class TPageMargins

TPageMargins

Support

Supported from 5.0

Description

Page margins.

Page margins are accessed via the public iPageMarginsInTwips member of class CPrintSetup. A single margin settings object applies throughout a document, so that gutter margins are not supported.

If the document contains headers and footers, they are located within the top and bottom margins respectively.

Defined in TPageMargins:
ExternalizeL(), InternalizeL(), iFooterOffset, iHeaderOffset, iMargins

void InternalizeL(RReadStream& aStream);

Description

Internalises a TPageMargins object from a read stream.

The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class.

Parameters

RWriteStream& aStream Stream from which the object should be internalised.

Leave codes

KErrNoMemory Internalisation caused an out of memory error.

void ExternalizeL(RWriteStream& aStream)const;

Description

Externalises a TPageMargins object to a write stream.

The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Parameters

RReadStream& aStream Stream to which the object should be externalised.

Leave codes

KErrNoMemory The write action caused the stream's resources to be exhausted.

TInt iFooterOffset

Description

The distance between the top of the footer and the top of the bottom margin in twips or pixels.

This must be less than the height of the bottom margin to ensure that the footer is visible.

TInt iHeaderOffset

Description

The distance between the top of the header and the top of the page in twips or pixels.

This must be less than the height of the top margin to ensure that the header is visible.

TMargins iMargins

Description

The widths of each of the four margins in twips or pixels.

See also:

• TMargins