textbase.h File Reference

Enum TTextBasePanic

This enumeration holds the possible panic codes that may be raised by the TextBase API on detecting an unrecoverable error.

EnumeratorValueDescription
ETextBasePanic_Unknown0

Not used

ETextBasePanic_InvalidInputParam1

One or more of the input parameters to the interface were invalid

ETextBasePanic_OutOfText2

Insufficient text for successful completion of the method

ETextBasePanic_Invariant3

Internal failure.

ETextBasePanic_Reserved14

Reserved panic codes. Not to be used.

ETextBasePanic_Reserved25
ETextBasePanic_TypefaceNameOverflow6

Setting a typeface name that is too long

Enum TFontPosture

Font posture flags. Fonts can be either upright or italic.

EnumeratorValueDescription
EPostureUpright

Font posture is normal (upright).

EPostureItalic

Font posture is italic.

Enum TFontStrokeWeight

Font stroke weight flags.

EnumeratorValueDescription
EStrokeWeightNormal

Font stroke weight is normal.

EStrokeWeightBold

Font stroke weight is bold.

Enum TFontPrintPosition

Font print position flags. Fonts can be normal, superscript or subscript.

EnumeratorValueDescription
EPrintPosNormal

Font is normal.

EPrintPosSuperscript

Font is superscript.

EPrintPosSubscript

Font is subscript.

KMaxTypefaceNameLength

const TIntKMaxTypefaceNameLength

The maximum length of a typeface name (in characters).

KMaxStyleNameLength

const TIntKMaxStyleNameLength

Enum TGlyphBitmapType

An enumerated type for the format of a glyph bitmap. This type is currently used to indicate whether glyph bitmaps for scalable fonts are drawn anti-aliased. Additional values may be defined in the future.

See also: TFontStyle::SetBitmapType() CFbsTypefaceStore::SetDefaultBitmapType()

EnumeratorValueDescription
EDefaultGlyphBitmap0

The font store's default glyph bitmap format is used.

EMonochromeGlyphBitmap

The standard monochrome format: no anti-aliasing, 1 bit per pixel, run-length encoded.

EAntiAliasedGlyphBitmap

Standard 8-bits-per-pixel with anti-aliasing.

ESubPixelGlyphBitmap

The format used when sub-pixel font rendering is used.

EFourColourBlendGlyphBitmap

The format used when outline and shadow font rendering is used.

If the raterizer supports the outline and shadow fonts, it will set the bitmaptype as EFourColourBlendGlyphBitmap but only when glyph bitmap type is set as EAntiAliasedGlyphBitmap and when any of the EDropShadow or EOutline effect is on. Only rasterizer providers can use this enum.

EGlyphBitmapTypeNotDefined

This is used for glyphs, and not fonts, and is needed to inform the font drawing routines that the character should be drawn using the overall font setting. For Internal Use Only.

EAntiAliasedOrMonochromeGlyphBitmap

This is used to inform the rasterizer that the best match should be found for the bitmap type based upon its knowledge. For Internal Use Only.

EFourColourBlendGlyphBitmapMono

The format used when outline and shadow font rendering is used. If the raterizer supports the outline and shadow fonts and EFourColourBlendGlyphBitmapMono is set, it will get regular monochrome bitmap.

KSuperSubScalingPercentage

const TIntKSuperSubScalingPercentage

The percentage used to multiply a normal font height when calculating its superscript or subscript height.

KSuperscriptOffsetPercentage

const TIntKSuperscriptOffsetPercentage

The percentage of a font height used to calculate its baseline offset for a superscript print position.

KSubscriptOffsetPercentage

const TIntKSubscriptOffsetPercentage

The percentage of a font height used to calculate its baseline offset for a subscript print position.

KMaxFontCacheEntries

const TIntKMaxFontCacheEntries

The maximum number of entries in the font cache.

See also: CFontCache

KFontCapitalAscent

const TUidKFontCapitalAscent

WARNING: this Class is for internal use ONLY. Compatibility is not guaranteed in future releases. UIDs corresponding to the CFont API extension functions

KFontMaxAscent

const TUidKFontMaxAscent

KFontStandardDescent

const TUidKFontStandardDescent

KFontMaxDescent

const TUidKFontMaxDescent

KFontLineGap

const TUidKFontLineGap

KFontGetFontTable

const TUidKFontGetFontTable

KFontGetGlyphOutline

const TUidKFontGetGlyphOutline

KFontReleaseGlyphOutline

const TUidKFontReleaseGlyphOutline

KFontReleaseFontTable

const TUidKFontReleaseFontTable