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

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef __com_sun_star_util_XStringWidth_idl__
#define __com_sun_star_util_XStringWidth_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

module com { module sun { module star { module util {

//============================================================================
/** An interface that encapsulates the abstract notion of string width.

    @see XStringAbbreviation
 */
published interface XStringWidth: com::sun::star::uno::XInterface
{
    //------------------------------------------------------------------------
    /** compute the width of a given string.

        <p>Depending on the implementation of this interface, the width of a
        string can be rather different things, like the number of characters
        in the string, or the width in pixel when displayed with a specific
        font.</p>

        @param aString
        The string that is to be measured.

        @returns
        the string's width.
     */
    long queryStringWidth([in] string aString);
};

}; }; }; };

#endif