Quelle  XStringWidth.idl   Sprache: unbekannt

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

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);
};

}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */