offapi/com/sun/star/awt/XFont.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module awt {
  23
  24
  25 /** describes a font on a specific device.
  26
  27     <p>All values are in pixels within this device.</p>
  28  */
  29 published interface XFont: com::sun::star::uno::XInterface
  30 {
  31
  32     /** returns the description of the font.
  33
  34         <p>The unit of measurement is pixels for the device.
  35      */
  36     com::sun::star::awt::FontDescriptor getFontDescriptor();
  37
  38
  39     /** returns additional information about the font.
  40      */
  41     com::sun::star::awt::SimpleFontMetric getFontMetric();
  42
  43
  44     /** returns the width of the specified character.
  45
  46         @returns
  47                 the character width measured in pixels for the device.
  48      */
  49     short getCharWidth( [in] char c );
  50
  51
  52     /** returns the widths of the specified characters.
  53
  54         @returns
  55                 a sequence of the widths of subsequent characters for this font.
  56      */
  57     sequence<short> getCharWidths( [in] char nFirst, [in] char nLast );
  58
  59
  60     /** returns the string width.
  61
  62         @returns
  63                 the width of the specified string of characters
  64                 measured in pixels for the device.
  65      */
  66     long getStringWidth( [in] string str );
  67
  68
  69     /** returns the string and the character widths.
  70
  71         @returns
  72                 the width of the specified string of characters
  73                 measured in pixels for the device.
  74
  75         @param str
  76                 the input string.
  77
  78         @param aDXArray
  79                 receives the width of every single character
  80                 measured in pixels for the device.
  81      */
  82     long getStringWidthArray( [in] string str,
  83              [out] sequence<long> aDXArray );
  84
  85
  86     /** queries the kerning pair table.
  87      */
  88     void getKernPairs( [out] sequence<char> Chars1,
  89              [out] sequence<char> Chars2,
  90              [out] sequence<short> Kerns );
  91
  92 };
  93
  94
  95 }; }; }; };
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */