offapi/com/sun/star/util/XStringWidth.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XStringWidth.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_util_XStringWidth_idl__
  32 #define __com_sun_star_util_XStringWidth_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module util {
  39
  40 //============================================================================
  41 /** An interface that encapsulates the abstract notion of string width.
  42
  43     @see XStringAbbreviation
  44  */
  45 published interface XStringWidth: com::sun::star::uno::XInterface
  46 {
  47     //------------------------------------------------------------------------
  48     /** compute the width of a given string.
  49
  50         <p>Depending on the implementation of this interface, the width of a
  51         string can be rather different things, like the number of characters
  52         in the string, or the width in pixel when displayed with a specific
  53         font.</p>
  54
  55         @param aString
  56         The string that is to be measured.
  57
  58         @returns
  59         the string's width.
  60      */
  61     long queryStringWidth([in] string aString);
  62 };
  63
  64 }; }; }; };
  65
  66 #endif