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

/**************************************************************
 * 
 * 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
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef __com_sun_star_text_XNumberingFormatter_idl__
#define __com_sun_star_text_XNumberingFormatter_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

module com { module sun { module star { module text {
/**
	supports the formatting of numberings
	in various language environments.
	@see <type scope="com::sun::star::text">NumberingRules</type>
	@see <type scope="com::sun::star::text">NumberingLevel</type>
	@version	1.0
	@author		<a href="mailto:oliver.specht@germany.sun.com">Oliver Specht</a>
*/
published interface XNumberingFormatter : com::sun::star::uno::XInterface
{
/** @returns
	the formatted numbering string according to the given
	<type scope="com::sun::star::text">NumberingLevel</type>
	and the given <type scope="com::sun::star::lang">Locale</type>.
*/
	string makeNumberingString(
				[in]sequence <com::sun::star::beans::PropertyValue> aProperties,
				[in]com::sun::star::lang::Locale aLocale)
			raises( com::sun::star::lang::IllegalArgumentException );
};
};};};};
#endif