/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XNumberFormatter.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 09:12:00 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_util_XNumberFormatter_idl__ 
#define __com_sun_star_util_XNumberFormatter_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__ 
#include <com/sun/star/util/XNumberFormatsSupplier.idl> 
#endif 
 
#ifndef __com_sun_star_util_NotNumericException_idl__ 
#include <com/sun/star/util/NotNumericException.idl> 
#endif 
 
#ifndef __com_sun_star_util_Color_idl__ 
#include <com/sun/star/util/Color.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module util {  
 
//============================================================================= 
 
/** represents a number formatter.
 */
published interface XNumberFormatter: com::sun::star::uno::XInterface
{ 
	//------------------------------------------------------------------------- 
	 
	/** attaches an <type>XNumberFormatsSupplier</type> to this 
		<type>NumberFormatter</type>.

		<p>This <type>NumberFormatter</type> will only use the <type>NumberFormats</type>
		specified in the attached <type>XNumberFormatsSupplier</type>. Without an attached 
		<type>XNumberFormatsSupplier</type>, no formatting is possible.</p>
	 */
	void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier ); 
 
	//------------------------------------------------------------------------- 
	 
	/** @returns  
				the attached <type>XNumberFormatsSupplier</type>.
	 */
	com::sun::star::util::XNumberFormatsSupplier getNumberFormatsSupplier(); 
 
	//------------------------------------------------------------------------- 
	 
	/** detects the number format in a string which contains a formatted number.
	 */
	long detectNumberFormat( [in] long nKey, 
			 [in] string aString ) 
			raises( com::sun::star::util::NotNumericException ); 
 
	//------------------------------------------------------------------------- 
	 
	/** converts a string which contains a formatted number into a number.
		
		<p>If this is a text format, the string will not be converted.</p>
	 */
	double convertStringToNumber( [in] long nKey, 
			 [in] string aString ) 
			raises( com::sun::star::util::NotNumericException ); 
 
	//------------------------------------------------------------------------- 
	 
	/** converts a number into a string.
	 */
	string convertNumberToString( [in] long nKey, 
			 [in] double fValue ); 
 
	//------------------------------------------------------------------------- 
	 
	/** @returns  
				the color which is specified for the given value in the number format,  
				which is otherwise the value of <var>aDefaultColor</var>.
	 */
	com::sun::star::util::Color queryColorForNumber( [in] long nKey, 
			 [in] double fValue, 
			 [in] com::sun::star::util::Color aDefaultColor ); 
 
	//------------------------------------------------------------------------- 
	 
	/** converts a string into another string.
	 */
	string formatString( [in] long nKey, 
			 [in] string aString ); 
 
	//------------------------------------------------------------------------- 
	 
	/** @returns  
				the color which is specified for the given string in the number format,  
				which is otherwise the value of <var>aDefaultColor</var>.
	 */
	com::sun::star::util::Color queryColorForString( [in] long nKey, 
			 [in] string aString, 
			 [in] com::sun::star::util::Color aDefaultColor ); 
 
	//------------------------------------------------------------------------- 
	 
	/** converts a number into a string with the specified format.
		
		<p>This string can always be converted back to a number using the same
		format.
		</p>
	 */
	string getInputString( [in] long nKey, 
			 [in] double fValue ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif

