Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: rendering ::

struct FontMetrics
Description
Metrics global to the font, i.e. not specific to single glyphs. The font height is defined as ascent+descent+internalLeading, and therefore not explicitely included here.

Please note that when querying FontMetrics from an XCanvasFont interface, all values here are given relative to the font cell size. That means, the referenceCharWidth and/or ascent+descent+internalLeading will approximately (rounded to integer device resolution, or exactly, if fractional font rendering is enabled) match the referenceAdvancement/cellSize members of the FontRequest for which the XCanvasFont was queried. Please be aware that the values returned in this structure only map one-to-one to device pixel, if the combined rendering transformation for text output equals the identity transformation. Otherwise, the text output (and thus the resulting metrics) will be subject to that transformation. Depending on the underlying font technology, actual device output might be off by up to one device pixel from the transformed metrics.

Since
OOo 2.0

Elements' Summary
Ascent Ascent (above the baseline) part of the font. 
Descent Descent (below the baseline) part of the font. 
InternalLeading Extra space above ascent 
ExternalLeading Extra space outside the font cells. 
ReferenceCharSize This value specifies the reference character width of the font. 
UnderlineOffset Specifies the offset to be added to the baseline when drawing underlined text.  
StrikeThroughOffset Specifies the offset to be added to the baseline when striking through the text.  
Elements' Details
Ascent
double Ascent;
Description
Ascent (above the baseline) part of the font.
Descent
double Descent;
Description
Descent (below the baseline) part of the font.
InternalLeading
double InternalLeading;
Description
Extra space above ascent
ExternalLeading
double ExternalLeading;
Description
Extra space outside the font cells.

It should not contain ink marks and is typically used by the font designer to modify the line distance.

ReferenceCharSize
double ReferenceCharSize;
Description
This value specifies the reference character width of the font.

It's roughly equivalent to the average width of all characters, and if one needs a font with double character width, the referenceCharSize should be doubled.

UnderlineOffset
double UnderlineOffset;
Description
Specifies the offset to be added to the baseline when drawing underlined text.
StrikeThroughOffset
double StrikeThroughOffset;
Description
Specifies the offset to be added to the baseline when striking through the text.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.