Class TOpenFontMetrics

TOpenFontMetrics

Support

Supported from 5.0

Description

Font metrics.

Defined in TOpenFontMetrics:
Ascent(), Descent(), MaxDepth(), MaxHeight(), MaxWidth(), SetAscent(), SetDescent(), SetMaxDepth(), SetMaxHeight(), SetMaxWidth(), SetSize(), Size(), TOpenFontMetrics()

See also:

• CFbsFont::GetFontMetrics()

TOpenFontMetrics();

Description

Default C++ constructor.

This creates then zero fills the object.

TOpenFontMetrics(const CFont* aFont);

Description

C++ constructor with a CFont parameter.

This creates a TOpenFontMetrics and initialises it with size, ascent, maximum height, descent, maximum depth and maximum character width information from the CFont that was passed as a parameter.

Parameters

const CFont* aFont The font from which to initialise the metrics object.

TInt Ascent() const;

Description

Gets the font's ascent.

Note:

• The ascent is usually the height of a Latin capital letter above the baseline.

Return value

TInt The font's ascent, in pixels.

See also:

• SetAscent()

TInt Descent() const;

Description

Gets the font's descent.

Note:

• The descent is usually the depth of a Latin lowercase 'p', 'q', or 'y' below the baseline.

Return value

TInt The font's descent, in pixels.

See also:

• SetDescent()

TInt MaxDepth() const;

Description

Gets the font's maximum depth.

Note:

• If this object was initialised from the CFont this will be the same as the descent.

• This is the descent for the character in the font which falls furthest below the baseline.

Return value

TInt The font's maximum depth.

See also:

• SetMaxDepth()

TInt MaxHeight() const;

Description

Sets the font's maximum height.

Note that if this object was initialised from the CFont this will be the same as the ascent.

Note:

• If this object was initialised from the CFont this will be the same as the ascent.

• This is the ascent for the character which is highest above the baseline. In many fonts this will be the height of an accented character like Â, including the accent.

Return value

TInt The maximum height of the font, in pixels.

See also:

• SetMaxDepth()

TInt MaxWidth() const;

Description

Gets the maximum character width, in pixels.

Return value

TInt The maximum character width, in pixels.

See also:

• SetMaxWidth()

void SetAscent(TInt aAscent);

Description

Sets the ascent.

Parameters

TInt aAscent The ascent, in pixels.

See also:

• Ascent()

void SetDescent(TInt aDescent);

Description

Sets the descent.

Parameters

TInt aDescent The descent, in pixels.

See also:

• Descent()

void SetMaxDepth(TInt aMaxDepth);

Description

Sets the font's maximum depth.

Parameters

TInt aMaxDepth The font's maximum depth, in pixels.

See also:

• MaxDepth()

void SetMaxHeight(TInt aMaxHeight);

Description

Sets the font's maximum height.

Parameters

TInt aMaxHeight The font's maximum height, in pixels.

See also:

• MaxHeight()

void SetMaxWidth(TInt aMaxWidth);

Description

Sets the maximum character width, in pixels.

Parameters

TInt aMaxWidth The maximum character width, in pixels.

See also:

• MaxWidth()

void SetSize(TInt aSize);

Description

Sets the font's size.

Parameters

TInt aSize The font's size.

See also:

• Size()

TInt Size() const;

Description

Gets the font's size.

Return value

TInt The font's size.

See also:

• SetSize()