Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

struct FontRequest
Description
This structure contains all information necessary to describe a font to be queried from XCanvas.

Note: Outline fonts are to be requested as a special family, set FontInfo::FamilyName appropriately. Emboss/relief must be emulated by upper layers.

Leave the FontInfo::FamilyName and FontInfo::StyleName empty, if font selection should only happen via the PANOSE description.

Since
OOo 2.0

Elements' Summary
FontDescription The description of the font. 
CellSize The size of the font in device coordinate space. 
ReferenceAdvancement This value specifies the size of the font in the writing direction (i.e. width for horizontal writing, and height for vertical writing). 
Locale The locale this font should be able to render. 
Elements' Details
FontDescription
FontInfo FontDescription;
Description
The description of the font.

This member contains the description of the font as returned by the font listing methods.

CellSize
double CellSize;
Description
The size of the font in device coordinate space.

This value corresponds to the font height in Western scripts, but is independent of the writing direction (see FontRequest::IsVertical below). That means, the value specified here is always measured orthogonal to the text advancement (height for horizontal writing, and width for vertical writing).

When this value is negative, its absolute value is taken as the character size of the font. If this value is positive, it's taken as the cell size of the font.

This member and the referenceAdvancement member are mutually exclusive, one of them has to be set to 0 (which means don't care).

For distorted fonts, the render transformation must be used. That is, the size specified here corresponds to device pixel only if the combined render transformation during text output equals the identity transform. This also applies to all query methods, for both XCanvasFont and XTextLayout.

ReferenceAdvancement
double ReferenceAdvancement;
Description
This value specifies the size of the font in the writing direction (i.e. width for horizontal writing, and height for vertical writing).

It is equivalent to the referenceCharSize of the FontMetrics structure.

This member and the cellSize member are mutually exclusive, one of them has to be set to 0 (which means don't care). For distorted fonts, the font matrix must be used.

Locale
::com::sun::star::lang::Locale Locale;
Description
The locale this font should be able to render.

This member supplements the FontInfo::UnicodeRange0 entry with a specific locale; this is e.g. important when selecting between traditional and simplified chinese is necessary (since the letters have the same unicode ranges and character values).

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.