Collapse all Symbian^3 Product Developer Library

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
- CBase

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)

Private Member Functions
	CLinkedTypefaceGroup(TInt)

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()

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

Private Attributes
TBaselineShift	iBaselineShift
TInt	iBoldnessPercentage
TInt	iGroupId
TInt	iItalicAngle
TScalingOption	iScalingOption

Constructor & Destructor Documentation

CLinkedTypefaceGroup(TInt)

CLinkedTypefaceGroup

(

TInt

aGroupId

)

[private]

Parameters

TInt aGroupId

~CLinkedTypefaceGroup()

~CLinkedTypefaceGroup

(

)

Default constructor

Member Functions Documentation

BaselineShift()

IMPORT_C TBaselineShift

BaselineShift

(

)

const

The baseline shift associated with the typefaces within this group.

BoldnessPercentage()

IMPORT_C TInt

BoldnessPercentage

(

)

const

Returns the current boldness percentage for this typeface group.

GroupId()

IMPORT_C TInt

GroupId

(

)

const

The group ID specified at construction.

ItalicAngle()

IMPORT_C TInt

ItalicAngle

(

)

const

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.

Parameters

TInt aGroupId

ScalingOption()

IMPORT_C TScalingOption

ScalingOption

(

)

const

The scaling option associated with the typefaces within this group.

CLinkedTypefaceGroup::TScalingOption

SetBaselineShift(TBaselineShift)

IMPORT_C void

SetBaselineShift

(

TBaselineShift

aShift

)

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

CLinkedTypefaceGroup::TBaselineShift

Parameters

TBaselineShift aShift

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.

Parameters

TInt 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

Parameters

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

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]