TZoomFactor Class Reference

class TZoomFactor : public MGraphicsDeviceMap

The interface for mapping between twips and device-specific units enriched with facilities to allow zooming.

The class is recursive, because a TZoomFactor object can have a MGraphicsDeviceMap (which could itself be a TZoomFactor) in its member data. This allows a zoom factor object to contain another zoom factor object, and is used to allow objects with different zoom factors to be embedded in each other to an arbitrary depth by the application architecture.

Inherits from

Constructor & Destructor Documentation

TZoomFactor()

IMPORT_CTZoomFactor()

TZoomFactor(const MGraphicsDeviceMap *)

TZoomFactor(const MGraphicsDeviceMap *aDevice)[inline]

Constructs a zoom factor object for a specific graphics device map.

The graphics map is either directly associated with a particular graphics device itself, or is associated with a hierarchy of device maps whose root map is associated with a particular graphics device.

Parameters

const MGraphicsDeviceMap * aDeviceThe graphics device map with which the zoom factor is associated.

TZoomFactor(const TZoomFactor *)

TZoomFactor(const TZoomFactor *aDevice)[inline]

Parameters

const TZoomFactor * aDevice

~TZoomFactor()

IMPORT_C~TZoomFactor()

Member Functions Documentation

GetNearestFontInTwips(CFont *&, const TFontSpec &)

IMPORT_C TIntGetNearestFontInTwips(CFont *&aFont,
const TFontSpec &aFontSpec
)[virtual]

Gets the font which is the nearest to the given font specification.

When the font is no longer needed, call ReleaseFont().

Note that this deprecated function is replaced by the new GetNearestFontToDesignHeightInTwips() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInTwips() function instead. This will guarantee that every character within any given text string will fit within the given amount of twips, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

KErrNone if successful; a system-wide error code otherwise.

Use GetNearestFontToDesignHeightInTwips

Parameters

CFont *& aFontOn return, contains a pointer to the nearest font.
const TFontSpec & aFontSpecThe specification of the font to be matched.

GetNearestFontToDesignHeightInTwips(CFont *&, const TFontSpec &)

IMPORT_C TIntGetNearestFontToDesignHeightInTwips(CFont *&,
const TFontSpec &
)[virtual]

Gets the font which is the nearest to the given font specification.

When the font is no longer needed, call ReleaseFont().

This new function replaces the deprecated GetNearestFontInTwips() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInTwips() function instead. This will guarantee that every character within any given text string will fit within the given amount of twips, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

KErrNone if successful; a system-wide error code otherwise.

Parameters

CFont *&
const TFontSpec &

GetNearestFontToMaxHeightInTwips(CFont *&, const TFontSpec &, TInt)

IMPORT_C TIntGetNearestFontToMaxHeightInTwips(CFont *&,
const TFontSpec &,
TInt
)[virtual]

Gets the font which is the nearest to the given font specification.

When the font is no longer needed, call ReleaseFont().

The font and bitmap server returns a pointer to the nearest matching font from those available. Matches to max height of font - this does its best to return a font that will fit within the maximum height specified (but note that variations due to hinting algorithms may rarely result in this height being exceeded by up to one pixel). Problems can also be encountered with bitmap fonts where the typeface exists but doesn't have a font small enough.

KErrNone if successful; a system-wide error code otherwise.

Parameters

CFont *&
const TFontSpec &
TInt

GraphicsDeviceMap()

const MGraphicsDeviceMap *GraphicsDeviceMap()const [inline]

Gets the graphics device map of this zoom factor object.

The graphics device map of the TZoomFactor.

HorizontalPixelsToTwips(TInt)

IMPORT_C TIntHorizontalPixelsToTwips(TIntaPixels)const [virtual]

Converts a horizontal dimension from pixels to twips.

An implementation is supplied by a derived class.

A horizontal dimension of a device in twips.

Parameters

TInt aPixelsA horizontal dimension of a device in pixels.

HorizontalTwipsToPixels(TInt)

IMPORT_C TIntHorizontalTwipsToPixels(TIntaTwips)const [virtual]

Converts a horizontal dimension from twips to pixels.

An implementation is supplied by a derived class.

A horizontal dimension of a device in pixels.

Parameters

TInt aTwipsA horizontal dimension of a device in twips.

ReleaseFont(CFont *)

IMPORT_C voidReleaseFont(CFont *aFont)[virtual]

Releases the specified font.

It is used to indicate that the specified font is no longer needed for use by the device map. As fonts can be shared between applications, this function does not delete the copy of the font from RAM unless the font was only being used by this particular device map.

An implementation is supplied by a derived class.

Parameters

CFont * aFontA pointer to the font to be released.

SetGraphicsDeviceMap(const MGraphicsDeviceMap *)

voidSetGraphicsDeviceMap(const MGraphicsDeviceMap *aDevice)[inline]

Sets the graphics device map for this zoom factor object.

Parameters

const MGraphicsDeviceMap * aDeviceThe graphics device map for this TZoomFactor.

SetTwipToPixelMapping(const TSize &, const TSize &)

IMPORT_C voidSetTwipToPixelMapping(const TSize &aSizeInPixels,
const TSize &aSizeInTwips
)

Parameters

const TSize & aSizeInPixels
const TSize & aSizeInTwips

SetZoomFactor(TInt)

IMPORT_C voidSetZoomFactor(TIntaZoomFactor)

Parameters

TInt aZoomFactor

VerticalPixelsToTwips(TInt)

IMPORT_C TIntVerticalPixelsToTwips(TIntaPixels)const [virtual]

Converts a vertical dimension from pixels to twips.

An implementation is supplied by a derived class.

A vertical dimension of a device in twips.

Parameters

TInt aPixelsA vertical dimension of a device in pixels.

VerticalTwipsToPixels(TInt)

IMPORT_C TIntVerticalTwipsToPixels(TIntaTwips)const [virtual]

Converts a vertical dimension from twips to pixels.

An implementation is supplied by a derived class.

A vertical dimension of a device in pixels.

Parameters

TInt aTwipsA vertical dimension of a device in twips.

ZoomFactor()

IMPORT_C TIntZoomFactor()const

Member Data Documentation

const MGraphicsDeviceMap * iDevice

const MGraphicsDeviceMap *iDevice[private]

TInt iZoomFactor

TInt iZoomFactor[private]