Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: GDI.H
Link against: gdi.lib

Class TMargins

class TMargins;

Description

A set of margins used for cropping a picture.

Margins are specified in twips or pixels.

Members

Defined in TMargins:
ExternalizeL(), InternalizeL(), iBottom, iLeft, iRight, iTop, operator!=(), operator==()


Member functions


InternalizeL()

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises a set of margins from a read stream.

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

Parameters

RReadStream &aStream

Stream from which the object is internalised.


ExternalizeL()

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises a set of margins to a write stream.

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

Parameters

RWriteStream &aStream

Stream to which the object is externalised.


operator==()

IMPORT_C TBool operator==(const TMargins &aMargins) const;

Description

Tests margins for equality.

Parameters

const TMargins &aMargins

The margin to be compared with this margin.

Return value

TBool

ETrue, if the margins are equal; EFalse, otherwise.


operator!=()

IMPORT_C TBool operator!=(const TMargins &aMargins) const;

Description

Tests margins for inequality.

Parameters

const TMargins &aMargins

The margin to be compared with this margin.

Return value

TBool

ETrue, if the margins are unequal; EFalse, otherwise.

[Top]


Member data


iLeft

TInt iLeft;

Description

Left margin, (in twips or pixels).


iRight

TInt iRight;

Description

Right margin, (in twips or pixels).


iTop

TInt iTop;

Description

Top margin, (in twips or pixels).


iBottom

TInt iBottom;

Description

Bottom margin, (in twips or pixels).