Collapse all Symbian^3 Application Developer Library

TPageMargins Class Reference

class TPageMargins

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.

Public Member Functions
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C void	InternalizeL ( RReadStream &)

Public Attributes
TInt	iFooterOffset
TInt	iHeaderOffset
TMargins	iMargins

Member Functions Documentation

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

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

RWriteStream & aStream

Stream to which the object should be externalised.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

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

RReadStream & aStream

Stream from which the object should be internalised.

Member Data Documentation

TInt iFooterOffset

TInt	iFooterOffset

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

TInt	iHeaderOffset

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

TMargins

iMargins

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

TMargins