Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XCanvasFont
Description
This interface provides access to a specific, XCanvas-dependent font incarnation. This font is not universally usable, but belongs to the XCanvas it was queried from.

Methods' Summary
createTextLayout Create a text layout interface. 
getFontRequest Query the FontRequest that was used to generate this object.  
getFontMetrics Query metric information about the font, that is generic to all its glyphs. 
getAvailableSizes Query the list of available font sizes. 
getExtraFontProperties Query the list of additional font properties. 
Methods' Details
createTextLayout
XTextLayout
createTextLayout( [in] StringContext  aText,
[in] byte  nDirection,
[in] hyper  nRandomSeed );

Description
Create a text layout interface.

Create a text layout interface for the given string, using this font to generate the glyphs from.

Parameter aText
The text to layout.
Parameter nDirection
Main text direction for the string specified. The main text direction is e.g. important for characters that are not strong, i.e. that change affinity according to the current writing direction. Make sure that across text portions and lines, the direction is set consistently.
Parameter nRandomSeed
Optional random seed for OpenType glyph variations.
getFontRequest
FontRequest
getFontRequest();

Description
Query the FontRequest that was used to generate this object.
getFontMetrics
FontMetrics
getFontMetrics();

Description
Query metric information about the font, that is generic to all its glyphs.

Note that the metric values in the returned result are in the font coordinate system, i.e. relative to the corresponding size of this font. That is, when this font was created with a cell size of 20 units, the metrics returned are calculated relative to this size.

getAvailableSizes
sequence< double >
getAvailableSizes();

Description
Query the list of available font sizes.

This method queries the list of available font sizes (in device units) for this font. For scalable fonts that are not restricted to discrete sizes, this list is empty, meaning that every size is possible. Fonts that do restrict the device size to certain discrete values, setting an overall transformation that scales the FontRequest::CellSize to something not contained in the list returned by this method can lead to visible disturbances.

getExtraFontProperties
sequence< ::com::sun::star::beans::PropertyValue >
getExtraFontProperties();

Description
Query the list of additional font properties.

Top of Page

Apache Software Foundation

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

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