1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_util_XStringWidth_idl__
25#define __com_sun_star_util_XStringWidth_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31module com { module sun { module star { module util {
32
33//============================================================================
34/** An interface that encapsulates the abstract notion of string width.
35
36    @see XStringAbbreviation
37 */
38published interface XStringWidth: com::sun::star::uno::XInterface
39{
40    //------------------------------------------------------------------------
41    /** compute the width of a given string.
42
43        <p>Depending on the implementation of this interface, the width of a
44        string can be rather different things, like the number of characters
45        in the string, or the width in pixel when displayed with a specific
46        font.</p>
47
48        @param aString
49        The string that is to be measured.
50
51        @returns
52        the string's width.
53     */
54    long queryStringWidth([in] string aString);
55};
56
57}; }; }; };
58
59#endif
60