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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_XFont_idl__
  29 #define __com_sun_star_awt_XFont_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/awt/FontDescriptor.idl>
  34
  35 #include <com/sun/star/awt/SimpleFontMetric.idl>
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** describes a font on a specific device.
  45
  46     <p>All values are in pixels within this device.</p>
  47  */
  48 published interface XFont: com::sun::star::uno::XInterface
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** returns the description of the font.
  53
  54         <p>The unit of measurement is pixels for the device.
  55      */
  56     com::sun::star::awt::FontDescriptor getFontDescriptor();
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** returns additional information about the font.
  61      */
  62     com::sun::star::awt::SimpleFontMetric getFontMetric();
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** returns the width of the specified character.
  67
  68         @returns
  69                 the character width measured in pixels for the device.
  70      */
  71     short getCharWidth( [in] char c );
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** returns the widths of the specified characters.
  76
  77         @returns
  78                 a sequence of the widths of subsequent characters for this font.
  79      */
  80     sequence<short> getCharWidths( [in] char nFirst, [in] char nLast );
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** returns the string width.
  85
  86         @returns
  87                 the width of the specified string of characters
  88                 measured in pixels for the device.
  89      */
  90     long getStringWidth( [in] string str );
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** returns the string and the character widths.
  95
  96         @returns
  97                 the width of the specified string of characters
  98                 measured in pixels for the device.
  99
 100         @param aDXArray
 101                 receives the width of every single character
 102                 measured in pixels for the device.
 103      */
 104     long getStringWidthArray( [in] string str,
 105              [out] sequence<long> aDXArray );
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** queries the kerning pair table.
 110      */
 111     void getKernPairs( [out] sequence<char> Chars1,
 112              [out] sequence<char> Chars2,
 113              [out] sequence<short> Kerns );
 114
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 #endif
 122
 123 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */