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