/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XFont.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 21:42:01 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XFont_idl__
#define __com_sun_star_awt_XFont_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_FontDescriptor_idl__
#include <com/sun/star/awt/FontDescriptor.idl>
#endif

#ifndef __com_sun_star_awt_SimpleFontMetric_idl__
#include <com/sun/star/awt/SimpleFontMetric.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

/** decribes a font on a specific device.

    <p>All values are in pixels within this device.</p>
 */
published interface XFont: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the description of the font.

        <p>The unit of measurement is pixels for the device.
     */
    com::sun::star::awt::FontDescriptor getFontDescriptor();

    //-------------------------------------------------------------------------

    /** returns additional information about the font.
     */
    com::sun::star::awt::SimpleFontMetric getFontMetric();

    //-------------------------------------------------------------------------

    /** returns the width of the specified character.

        @returns
                the character width measured in pixels for the device.
     */
    short getCharWidth( [in] char c );

    //-------------------------------------------------------------------------

    /** returns the widths of the specified characters.

        @returns
                a sequence of the widths of subsequent characters for this font.
     */
    sequence<short> getCharWidths( [in] char nFirst, [in] char nLast );

    //-------------------------------------------------------------------------

    /** returns the string width.

        @returns
                the width of the specified string of characters
                measured in pixels for the device.
     */
    long getStringWidth( [in] string str );

    //-------------------------------------------------------------------------

    /** returns the string and the character widths.

        @returns
                the width of the specified string of characters
                measured in pixels for the device.

        @param aDXArray
                receives the width of every single character
                measured in pixels for the device.
     */
    long getStringWidthArray( [in] string str,
             [out] sequence<long> aDXArray );

    //-------------------------------------------------------------------------

    /** queries the kerning pair table.
     */
    void getKernPairs( [out] sequence<char> Chars1,
             [out] sequence<char> Chars2,
             [out] sequence<short> Kerns );

};

//=============================================================================

}; }; }; };

#endif
