offapi/com/sun/star/util/XStringAbbreviation.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: XStringAbbreviation.idl,v $
  10  * $Revision: 1.6 $
  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_XStringAbbreviation_idl__
  32 #define __com_sun_star_util_XStringAbbreviation_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      published interface XStringWidth;
  40 }; }; }; };
  41
  42 module com { module sun { module star { module util {
  43
  44 //============================================================================
  45 /** Abbreviate arbitrary strings.
  46
  47     <p>It is expected that there will be different implementations of this
  48     interface, that each expect strings conforming to a certain structure
  49     (e.g., URIs, platform-specific file paths, or newsgroup names).  The
  50     abbreviation algorithms will then take into account the structural
  51     information.</p>
  52
  53     @see XStringWidth
  54  */
  55 published interface XStringAbbreviation: com::sun::star::uno::XInterface
  56 {
  57     //------------------------------------------------------------------------
  58     /** Abbreviate a string, so that the resulting abbreviated string is not
  59         wider than some given width.
  60
  61         <p>The width of a string is an abstract concept here, measured via
  62         an <type>XStringWidth</type> interface.  Examples are the number of
  63         characters in the string (<type>XStringWidth</type> will measure the
  64         string's length), or the width in pixel when displayed with a specific
  65         font (which <type>XStringWidth</type> would encapsulate).</p>
  66
  67         @param xStringWidth
  68         The interface that makes concrete the abstract notion of string width.
  69
  70         @param nWidth
  71         The resulting abbreviated string's width will be no larger than this.
  72
  73         @param aString
  74         The string that is abbreviated.
  75
  76         @returns
  77         an abbreviated string.
  78      */
  79     string abbreviateString([in] XStringWidth xStringWidth,
  80                             [in] long nWidth,
  81                             [in] string aString);
  82 };
  83
  84 }; }; }; };
  85
  86 #endif