1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_util_XStringAbbreviation_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_util_XStringAbbreviation_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweirmodule com { module sun { module star { module util { 36*cdf0e10cSrcweir published interface XStringWidth; 37*cdf0e10cSrcweir}; }; }; }; 38*cdf0e10cSrcweir 39*cdf0e10cSrcweirmodule com { module sun { module star { module util { 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir//============================================================================ 42*cdf0e10cSrcweir/** Abbreviate arbitrary strings. 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir <p>It is expected that there will be different implementations of this 45*cdf0e10cSrcweir interface, that each expect strings conforming to a certain structure 46*cdf0e10cSrcweir (e.g., URIs, platform-specific file paths, or newsgroup names). The 47*cdf0e10cSrcweir abbreviation algorithms will then take into account the structural 48*cdf0e10cSrcweir information.</p> 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir @see XStringWidth 51*cdf0e10cSrcweir */ 52*cdf0e10cSrcweirpublished interface XStringAbbreviation: com::sun::star::uno::XInterface 53*cdf0e10cSrcweir{ 54*cdf0e10cSrcweir //------------------------------------------------------------------------ 55*cdf0e10cSrcweir /** Abbreviate a string, so that the resulting abbreviated string is not 56*cdf0e10cSrcweir wider than some given width. 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir <p>The width of a string is an abstract concept here, measured via 59*cdf0e10cSrcweir an <type>XStringWidth</type> interface. Examples are the number of 60*cdf0e10cSrcweir characters in the string (<type>XStringWidth</type> will measure the 61*cdf0e10cSrcweir string's length), or the width in pixel when displayed with a specific 62*cdf0e10cSrcweir font (which <type>XStringWidth</type> would encapsulate).</p> 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir @param xStringWidth 65*cdf0e10cSrcweir The interface that makes concrete the abstract notion of string width. 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir @param nWidth 68*cdf0e10cSrcweir The resulting abbreviated string's width will be no larger than this. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @param aString 71*cdf0e10cSrcweir The string that is abbreviated. 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir @returns 74*cdf0e10cSrcweir an abbreviated string. 75*cdf0e10cSrcweir */ 76*cdf0e10cSrcweir string abbreviateString([in] XStringWidth xStringWidth, 77*cdf0e10cSrcweir [in] long nWidth, 78*cdf0e10cSrcweir [in] string aString); 79*cdf0e10cSrcweir}; 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir}; }; }; }; 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir#endif 84