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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XNumberingFormatter_idl__
  28 #define __com_sun_star_text_XNumberingFormatter_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33 #ifndef __com_sun_star_beans_PropertyValue_idl__
  34 #include <com/sun/star/beans/PropertyValue.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_Locale_idl__
  37 #include <com/sun/star/lang/Locale.idl>
  38 #endif
  39 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  40 #include <com/sun/star/lang/IllegalArgumentException.idl>
  41 #endif
  42
  43 module com { module sun { module star { module text {
  44 /**
  45     supports the formatting of numberings
  46     in various language environments.
  47     @see <type scope="com::sun::star::text">NumberingRules</type>
  48     @see <type scope="com::sun::star::text">NumberingLevel</type>
  49     @version    1.0
  50     @author     <a href="mailto:oliver.specht@germany.sun.com">Oliver Specht</a>
  51 */
  52 published interface XNumberingFormatter : com::sun::star::uno::XInterface
  53 {
  54 /** @returns
  55     the formatted numbering string according to the given
  56     <type scope="com::sun::star::text">NumberingLevel</type>
  57     and the given <type scope="com::sun::star::lang">Locale</type>.
  58 */
  59     string makeNumberingString(
  60                 [in]sequence <com::sun::star::beans::PropertyValue> aProperties,
  61                 [in]com::sun::star::lang::Locale aLocale)
  62             raises( com::sun::star::lang::IllegalArgumentException );
  63 };
  64 };};};};
  65 #endif