forked from amazingfate/loongoffice
944eb99027
Doxygen does not know type element and will recognize strings that contain capital letter (all API types do) automatically as type. This patch removes 15k doxygen warnings. git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1," Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
74 lines
2.6 KiB
Plaintext
74 lines
2.6 KiB
Plaintext
/* -*- 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 .
|
|
*/
|
|
|
|
#ifndef __com_sun_star_util_XStringAbbreviation_idl__
|
|
#define __com_sun_star_util_XStringAbbreviation_idl__
|
|
|
|
#include <com/sun/star/uno/XInterface.idl>
|
|
|
|
module com { module sun { module star { module util {
|
|
published interface XStringWidth;
|
|
}; }; }; };
|
|
|
|
module com { module sun { module star { module util {
|
|
|
|
/** Abbreviate arbitrary strings.
|
|
|
|
<p>It is expected that there will be different implementations of this
|
|
interface, that each expect strings conforming to a certain structure
|
|
(e.g., URIs, platform-specific file paths, or newsgroup names). The
|
|
abbreviation algorithms will then take into account the structural
|
|
information.</p>
|
|
|
|
@see XStringWidth
|
|
*/
|
|
published interface XStringAbbreviation: com::sun::star::uno::XInterface
|
|
{
|
|
/** Abbreviate a string, so that the resulting abbreviated string is not
|
|
wider than some given width.
|
|
|
|
<p>The width of a string is an abstract concept here, measured via
|
|
an XStringWidth interface. Examples are the number of
|
|
characters in the string (XStringWidth will measure the
|
|
string's length), or the width in pixel when displayed with a specific
|
|
font (which XStringWidth would encapsulate).</p>
|
|
|
|
@param xStringWidth
|
|
The interface that makes concrete the abstract notion of string width.
|
|
|
|
@param nWidth
|
|
The resulting abbreviated string's width will be no larger than this.
|
|
|
|
@param aString
|
|
The string that is abbreviated.
|
|
|
|
@returns
|
|
an abbreviated string.
|
|
*/
|
|
string abbreviateString([in] XStringWidth xStringWidth,
|
|
[in] long nWidth,
|
|
[in] string aString);
|
|
};
|
|
|
|
}; }; }; };
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|