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

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