CLinkedTypefaceGroup Class Reference

#include <linkedfonts.h>

Link against: fntstr.lib

class CLinkedTypefaceGroup : public CBase

Inherits from

CLinkedTypefaceGroup

Public Member Enumerations
enum	TBaselineShift { EBaselineShift, ENoBaselineShift }
enum	TScalingOption { EScalingNone, EScalingUp, EScalingDown, EScalingUpOrDown }

Public Member Functions
	~CLinkedTypefaceGroup()
IMPORT_C TBaselineShift	BaselineShift()
IMPORT_C TInt	BoldnessPercentage()
IMPORT_C TInt	GroupId()
IMPORT_C TInt	ItalicAngle()
IMPORT_C CLinkedTypefaceGroup *	NewLC(TInt)
IMPORT_C TScalingOption	ScalingOption()
IMPORT_C void	SetBaselineShift(TBaselineShift)
IMPORT_C void	SetBoldnessPercentage(TInt)
IMPORT_C void	SetItalicAngle(TInt)
IMPORT_C void	SetScalingOption(TScalingOption)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

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.

Member Enumeration Documentation

Enum TBaselineShift

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

Enumerator	Value	Description
EBaselineShift
ENoBaselineShift

Enum TScalingOption

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

Enumerator	Value	Description
EScalingNone
EScalingUp
EScalingDown
EScalingUpOrDown

Constructor & Destructor Documentation

~CLinkedTypefaceGroup ( )

~CLinkedTypefaceGroup

(

)

Default constructor

Member Function Documentation

BaselineShift ( )

IMPORT_C TBaselineShift

BaselineShift

(

)

const

The baseline shift associated with the typefaces within this group.

Returns: TBaselineShift The baseline shift

BoldnessPercentage ( )

IMPORT_C TInt

BoldnessPercentage

(

)

const

Returns the current boldness percentage for this typeface group.

Returns: The current boldness percentage for this typeface group

GroupId ( )

IMPORT_C TInt

GroupId

(

)

const

The group ID specified at construction.

Returns: TInt The group ID of this group

ItalicAngle ( )

IMPORT_C TInt

ItalicAngle

(

)

const

The angle (slant) of italic text

Returns: The angle (slant) of italic text

NewLC ( TInt )

IMPORT_C CLinkedTypefaceGroup *

NewLC

(

TInt

aGroupId

)

[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.

Returns: CLinkedTypefaceGroup* A newly constructed group

ScalingOption ( )

IMPORT_C TScalingOption

ScalingOption

(

)

const

The scaling option associated with the typefaces within this group.

Returns: TScalingOption Scaling options

SetBaselineShift ( TBaselineShift )

IMPORT_C void

SetBaselineShift

(

TBaselineShift

aShift

)

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

SetBoldnessPercentage ( TInt )

IMPORT_C void

SetBoldnessPercentage

(

TInt

aPercentage

)

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.

Parameter	Description
aPercentage	The boldness percentage to be used by this group.

SetItalicAngle ( TInt )

IMPORT_C void

SetItalicAngle

(

TInt

aAngle

)

Sets the angle (slant) of italic text

Parameter	Description
aAngle	The angle (slant) of italic text

SetScalingOption ( TScalingOption )

IMPORT_C void

SetScalingOption

(

TScalingOption

aOption

)

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