CLinkedTypefaceGroup Class Reference

class CLinkedTypefaceGroup : public CBase

This class contains parameters used to describe the groups that linked typeface elements are associated to. These "metrics" apply to all fonts that are specified to be within the group.

WARNING: Class for internal and partner use ONLY. Compatibility is not guaranteed in future releases.

Inherits from

  • CLinkedTypefaceGroup

Constructor & Destructor Documentation

CLinkedTypefaceGroup(TInt)

CLinkedTypefaceGroup(TIntaGroupId)[private]

Parameters

TInt aGroupId

~CLinkedTypefaceGroup()

~CLinkedTypefaceGroup()

Default constructor

Member Functions Documentation

BaselineShift()

IMPORT_C TBaselineShiftBaselineShift()const

The baseline shift associated with the typefaces within this group.

BoldnessPercentage()

IMPORT_C TIntBoldnessPercentage()const

Returns the current boldness percentage for this typeface group.

GroupId()

IMPORT_C TIntGroupId()const

The group ID specified at construction.

ItalicAngle()

IMPORT_C TIntItalicAngle()const

The angle (slant) of italic text

NewLC(TInt)

IMPORT_C CLinkedTypefaceGroup *NewLC(TIntaGroupId)[static]

Constructs a new linked typeface group with the specified ID and places it on the CleanupStack.

By default the Antialiasing Threshold, Boldness Percentage and Italic Angle are set to -1. The rasterizer will apply its "best-guess" as to the value in this case. The default scaling option is EScalingNone; the default baseline shift is ENoBaselineShift.

Parameters

TInt aGroupId

ScalingOption()

IMPORT_C TScalingOptionScalingOption()const

The scaling option associated with the typefaces within this group.

CLinkedTypefaceGroup::TScalingOption

SetBaselineShift(TBaselineShift)

IMPORT_C voidSetBaselineShift(TBaselineShiftaShift)

Sets whether the baseline of typefaces within this group is shifted.

CLinkedTypefaceGroup::TBaselineShift

Parameters

TBaselineShift aShift

SetBoldnessPercentage(TInt)

IMPORT_C voidSetBoldnessPercentage(TIntaPercentage)

Sets the boldness percentage used by typefaces belonging to this group.

The percentage is relative to the font size specified. For example if a font with an em height of 18 has a boldness percentage of 5% the resulting emboldened text will be emboldened by 18 x (5 / 100) = 0.9 pixels.

Parameters

TInt aPercentageThe boldness percentage to be used by this group.

SetItalicAngle(TInt)

IMPORT_C voidSetItalicAngle(TIntaAngle)

Sets the angle (slant) of italic text

Parameters

TInt aAngleThe angle (slant) of italic text

SetScalingOption(TScalingOption)

IMPORT_C voidSetScalingOption(TScalingOptionaOption)

Sets the scaling option associated with the typefaces within this group.

CLinkedTypefaceGroup::TScalingOption

Parameters

TScalingOption aOption

Member Enumerations Documentation

Enum TBaselineShift

Specifies whether the font baseline of fonts belonging to this group should be shifted or not.

Enumerators

EBaselineShift
ENoBaselineShift

Enum TScalingOption

Specifies the different ways in which a typeface belonging to this group can be scaled.

Enumerators

EScalingNone
EScalingUp
EScalingDown
EScalingUpOrDown

Member Data Documentation

TBaselineShift iBaselineShift

TBaselineShift iBaselineShift[private]

TInt iBoldnessPercentage

TInt iBoldnessPercentage[private]

TInt iGroupId

TInt iGroupId[private]

TInt iItalicAngle

TInt iItalicAngle[private]

TScalingOption iScalingOption

TScalingOption iScalingOption[private]