#include <mw/AknTextDecorationMetrics.h>
| class TAknTextDecorationMetrics |
| Public Member Functions | |
|---|---|
| TAknTextDecorationMetrics(TInt) | |
| TAknTextDecorationMetrics(const CFont *) | |
| TAknTextDecorationMetrics(const TAknFontSpecification &) | |
| IMPORT_C TInt | BaselineToUnderlineOffset() |
| IMPORT_C TInt | CursorWidth() |
| IMPORT_C void | GetLeftAndRightMargins(TInt &, TInt &) |
| IMPORT_C void | GetTopAndBottomMargins(TInt &, TInt &) |
| IMPORT_C TInt | UnderlineHeight() |
This class contains information to decorate a text with highlights, cursors and margins
Construction is performed driven by metrics and style derived from the various object that are used in the different contstructors. The metrics used are height, weight, and posture.
From Series 60 font id, the current layout is accessed to provide metrics and style info. From a CFont object, the font's own accessible metrics and styles are accessed (e.g. HeightInPixels()) From a TFontSpec object, the height and style are extracted via its APIs.
| IMPORT_C | TAknTextDecorationMetrics | ( | TInt | aFontId | ) |
Construct the object with values that are correct for the given font identifier.
| IMPORT_C | TAknTextDecorationMetrics | ( | const CFont * | aFont | ) |
Construct the object with values that are correct for the given Symbian Font A null pointer passed in will result in a default set of metrics.
| IMPORT_C | TAknTextDecorationMetrics | ( | const TAknFontSpecification & | aFontSpecification | ) |
Construct the object with values that are correct for the given Series 60 Font Specification. This constructor depends upon the font height and boldness being set in the font specifcation object.
| IMPORT_C TInt | BaselineToUnderlineOffset | ( | ) | const |
Offset distance measured from the bottom of the baseline row of pixels to the bottom of the underline. E.g. if this method returns 3, and the underline height is 1, then there are 2 pixel rows of gap between the baseline of glyphs and the underline.
The baseline referred to is the natural baseline of the glyph, not the formal baseline reported by the font. To draw the underline, it may be necessary, depending on how the font is compounded, to find the baseline (i.e. ascent) of individual character codes' glyphs.
Returns: Offset distance measured from bottom of glyphs baseline to bottom of underline graphics
| IMPORT_C TInt | CursorWidth | ( | ) | const |
Width of the cursor in pixels. This width is to be used when cursor is drawn rather than an image.
Returns: Width of the cursor in pixels.
Fetch the values in pixels for the distances reserved for cursor and highlights that extend beyond the font's rendering area (where the glyphs draw)
Values are positive for any normal margin - one that is outside the glyphs area.
| Parameter | Description |
|---|---|
| aLeft | number of extra columns of pixels left of glyphs for additional graphics |
| aRight | number of extra rows of pixels right of glyphs for additional graphics |
Fetch the values in pixels for the distances reserved for cursor and highlights that extend beyond the font's rendering area (where the glyphs draw)
Values are positive for any normal margin - one that is outside the glyphs area.
| Parameter | Description |
|---|---|
| aTop | number of extra rows of pixels below font descent for additional graphics |
| IMPORT_C TInt | UnderlineHeight | ( | ) | const |
Height (i.e. thickness) of the drawing of the underline Positive for any visible line. e.g. a value of 1, means one row of pixels is drawn.
Returns: Number of rows pixels in the underline graphics