diff options
Diffstat (limited to 'offapi/com/sun/star/rendering/FontMetrics.idl')
-rw-r--r-- | offapi/com/sun/star/rendering/FontMetrics.idl | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rendering/FontMetrics.idl b/offapi/com/sun/star/rendering/FontMetrics.idl new file mode 100644 index 000000000..2aee571f0 --- /dev/null +++ b/offapi/com/sun/star/rendering/FontMetrics.idl @@ -0,0 +1,95 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_rendering_FontMetrics_idl__ +#define __com_sun_star_rendering_FontMetrics_idl__ + +module com { module sun { module star { module rendering { + +/** Metrics global to the font, i.e. not specific to single + glyphs. The font height is defined as + ascent+descent+internalLeading, and therefore not explicitly + included here.<p> + + 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 + */ +struct FontMetrics +{ + /// Ascent (above the baseline) part of the font. + double Ascent; + + + /// Descent (below the baseline) part of the font. + double Descent; + + + /// Extra space above ascent + double InternalLeading; + + + /** Extra space outside the font cells.<p> + + It should not contain ink marks and is typically used + by the font designer to modify the line distance.<p> + */ + double ExternalLeading; + + + /** This value specifies the reference character width of the + font.<p> + + 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.<p> + */ + double ReferenceCharSize; + + + /** Specifies the offset to be added to the baseline when drawing + underlined text. + */ + double UnderlineOffset; + + + /** Specifies the offset to be added to the baseline when striking + through the text. + */ + double StrikeThroughOffset; + +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |