offapi/com/sun/star/text/XNumberingFormatter.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_XNumberingFormatter_idl__
  20 #define __com_sun_star_text_XNumberingFormatter_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/PropertyValue.idl>
  24 #include <com/sun/star/lang/Locale.idl>
  25 #include <com/sun/star/lang/IllegalArgumentException.idl>
  26
  27 module com { module sun { module star { module text {
  28 /**
  29     supports the formatting of numberings
  30     in various language environments.
  31     @see com::sun::star::text::NumberingRules
  32     @see com::sun::star::text::NumberingLevel
  33     @version    1.0
  34     @author     <a href="mailto:oliver.specht@germany.sun.com">Oliver Specht</a>
  35 */
  36 published interface XNumberingFormatter : com::sun::star::uno::XInterface
  37 {
  38 /** @returns
  39     the formatted numbering string according to the given
  40     com::sun::star::text::NumberingLevel
  41     and the given com::sun::star::lang::Locale.
  42 */
  43     string makeNumberingString(
  44                 [in]sequence <com::sun::star::beans::PropertyValue> aProperties,
  45                 [in]com::sun::star::lang::Locale aLocale)
  46             raises( com::sun::star::lang::IllegalArgumentException );
  47 };
  48 };};};};
  49 #endif
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */