| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #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 explicitely |
| 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 OpenOffice 2.0 |
| */ |
| published 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 |