TOpenFontFaceAttrib Class Reference

#include <openfont.h>

class TOpenFontFaceAttrib : public TOpenFontFaceAttribBase

Inherits from

Public Member Functions
TOpenFontFaceAttrib()
TPtrC FamilyName()
TPtrC FullName()
TPtrC LocalFamilyName()
TPtrC LocalFullName()
TInt MinSizeInPixels()
voidSetFamilyName(const TDesC &)
voidSetFullName(const TDesC &)
voidSetLocalFamilyName(const TDesC &)
voidSetLocalFullName(const TDesC &)
voidSetMinSizeInPixels(TInt)
TPtrC ShortFamilyName()
TPtrC ShortFullName()
TPtrC ShortLocalFamilyName()
TPtrC ShortLocalFullName()
TBool operator==(const TOpenFontFaceAttrib &)
Inherited Attributes
TOpenFontFaceAttribBase::iCoverage
TOpenFontFaceAttribBase::iName
TOpenFontFaceAttribBase::iReserved
TOpenFontFaceAttribBase::iStyle
Inherited Enumerations
TOpenFontFaceAttribBase:@49
TOpenFontFaceAttribBase:@50
TOpenFontFaceAttribBase:@51
TOpenFontFaceAttribBase:@52
Inherited Functions
TOpenFontFaceAttribBase::Coverage()const
TOpenFontFaceAttribBase::HasCJK()const
TOpenFontFaceAttribBase::HasCyrillic()const
TOpenFontFaceAttribBase::HasGreek()const
TOpenFontFaceAttribBase::HasHangul()const
TOpenFontFaceAttribBase::HasKana()const
TOpenFontFaceAttribBase::HasLatin()const
TOpenFontFaceAttribBase::IsBold()const
TOpenFontFaceAttribBase::IsItalic()const
TOpenFontFaceAttribBase::IsMonoWidth()const
TOpenFontFaceAttribBase::IsSerif()const
TOpenFontFaceAttribBase::IsSymbol()const
TOpenFontFaceAttribBase::Name()const
TOpenFontFaceAttribBase::SetBold(TBool)
TOpenFontFaceAttribBase::SetCoverage(TUint,TUint,TUint,TUint)
TOpenFontFaceAttribBase::SetItalic(TBool)
TOpenFontFaceAttribBase::SetMonoWidth(TBool)
TOpenFontFaceAttribBase::SetName(const TDesC &)
TOpenFontFaceAttribBase::SetSerif(TBool)
TOpenFontFaceAttribBase::TOpenFontFaceAttribBase()
TOpenFontFaceAttribBase::operator==(const TOpenFontFaceAttribBase &)const

Detailed Description

Typeface attributes.

These attributes include the name, family name, and supported scripts.

See also: CFbsFont::GetFaceAttrib()

Constructor & Destructor Documentation

TOpenFontFaceAttrib ( )

TOpenFontFaceAttrib()[inline]

Default C++ constructor.

The function initialises the minimum typeface size to zero, the names to NULL, and the coverage and style flags to zero.

Member Function Documentation

FamilyName ( )

TPtrC FamilyName()const [inline]

Gets the family name.

Note: The family name of the typeface does not include style attributes like "Italic".

See also: FullName()

Returns: The family name of the typeface.

FullName ( )

TPtrC FullName()const [inline]

Gets the full name.

The full name of the typeface includes style attributes like Italic, Bold, and Cursive.

See also: FamilyName()

Returns: The full name of the typeface.

LocalFamilyName ( )

TPtrC LocalFamilyName()const [inline]

Gets the local family name.

The local name of the typeface is the name in the language of the current locale, where this is provided by the font file. If the local name is not available then the local name will be the same as the ordinary name.

Note: The family name of the typeface does not include style attributes like 'Italic'.

Returns: The local family name of the typeface.

LocalFullName ( )

TPtrC LocalFullName()const [inline]

Gets the local full name.

The local full name of the typeface includes style attributes like Italic, Bold, and Cursive.

The local name of the typeface is the name in the language of the current locale, where this is provided by the font file. If the local name is not available then the local name will be the same as the ordinary name.

Returns: The local full name of the typeface.

MinSizeInPixels ( )

TInt MinSizeInPixels()const [inline]

Gets the minimum typeface size.

This is the smallest size that can be drawn legibly.

Returns: The minimum typeface size (in pixels).

SetFamilyName ( const TDesC & )

voidSetFamilyName(const TDesC &aName)[inline]

Sets the family name.

See also: FamilyName()

ParameterDescription
aNameThe family name of the typeface.

SetFullName ( const TDesC & )

voidSetFullName(const TDesC &aName)[inline]

Sets the full name.

See also: FullName()

ParameterDescription
aNameThe full name of the typeface.

SetLocalFamilyName ( const TDesC & )

voidSetLocalFamilyName(const TDesC &aName)[inline]

Sets the local family name.

See also: LocalFamilyName()

ParameterDescription
aNameThe local family name of the typeface.

SetLocalFullName ( const TDesC & )

voidSetLocalFullName(const TDesC &aName)[inline]

Sets the local full name.

See also: LocalFullName()

ParameterDescription
aNameThe local full name of the typeface.

SetMinSizeInPixels ( TInt )

voidSetMinSizeInPixels(TIntaSize)[inline]

Set the minimum typeface size.

This is the smallest size that can be drawn legibly.

See also: MinSizeInPixels()

ParameterDescription
aSizeSets the minimum typeface size (in pixels).

ShortFamilyName ( )

TPtrC ShortFamilyName()const [inline]

Gets the short family name.

This is the family name, truncated to KMaxTypefaceNameLength, if necessary.

Note: Short names are names truncated to KMaxTypefaceNameLength (24) characters where necessary so that they can be used in the TTypeFace class. The Open Font Framework allows 32 characters as a maximum name length.

See also: FamilyName()

Returns: The short family name of the typeface.

ShortFullName ( )

TPtrC ShortFullName()const [inline]

Gets the short full name.

This is the full name of the typeface, truncated to KMaxTypefaceNameLength, if necessary.

Note: Short names are names truncated to KMaxTypefaceNameLength (24) characters where necessary so that they can be used in the TTypeFace class. The Open Font Framework allows 32 characters as a maximum name length.

See also: FullName()

Returns: The short full name of the typeface.

ShortLocalFamilyName ( )

TPtrC ShortLocalFamilyName()const [inline]

Gets the short local family name.

This is the local family name of the typeface, truncated to KMaxTypefaceNameLength, if necessary.

Note: Short names are names truncated to KMaxTypefaceNameLength (24) characters where necessary so that they can be used in the TTypeFace class. The Open Font Framework allows 32 characters as a maximum name length.

See also: LocalFamilyName()

Returns: The short local family name of the typeface.

ShortLocalFullName ( )

TPtrC ShortLocalFullName()const [inline]

Gets the short local full name.

This is the local full name of the typeface, truncated to KMaxTypefaceNameLength, if necessary.

Note: Short names are names truncated to KMaxTypefaceNameLength (24) characters where necessary so that they can be used in the TTypeFace class. The Open Font Framework allows 32 characters as a maximum name length.

See also: LocalFullName()

Returns: The short local full name of the typeface.

operator== ( const TOpenFontFaceAttrib & )

TBool operator==(const TOpenFontFaceAttrib &aAttrib)const [inline]

Equality operator.

Compares this and another set of font attributes, including the coverage, the family name, the local full name, the local family name, and the minimum size in pixels.

ParameterDescription
aAttribContains the font attributes and names to compare.

Returns: ETrue if all values are equal, EFalse if not.