/*************************************************************************
 *
 *  $RCSfile: XNumberFormatPreviewer.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: kz $ $Date: 2004-05-19 10:46:34 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_util_XNumberFormatPreviewer_idl__
#define __com_sun_star_util_XNumberFormatPreviewer_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_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

#ifndef __com_sun_star_util_MalformedNumberFormatException_idl__
#include <com/sun/star/util/MalformedNumberFormatException.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 which can preview number
    formats without inserting them.

    @see NumberFormatter
 */
interface XNumberFormatPreviewer: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** formats a value using a format string, without inserting a
        number format into the list.

        @param aFormat
            is the format string that is used for formatting.

        @param fValue
            is the value that is formatted.

        @param nLocale
            is the locale that is used to interpret the format string.

        @param bAllowEnglish
            specifies if English language number format strings are accepted
            in addition to those from the selected locale.

        @returns
            the formatted string.

        @throws com::sun::star::util::MalformedNumberFormatException
            if the format string is invalid.

     */
    string convertNumberToPreviewString( [in] string aFormat,
             [in] double fValue,
             [in] com::sun::star::lang::Locale nLocale,
             [in] boolean bAllowEnglish )
            raises( com::sun::star::util::MalformedNumberFormatException );

    //-------------------------------------------------------------------------

    /** returns the color which is to be used for a number.

        @param aFormat
            is the format string that is used for formatting.

        @param fValue
            is the value that is formatted.

        @param nLocale
            is the locale that is used to interpret the format string.

        @param bAllowEnglish
            specifies if English language number format strings are accepted
            in addition to those from the selected locale.

        @param aDefaultColor
            is the color that should be returned if no color is set by
            the number format.

        @returns
            the color that should used to output the formatted string.

        @throws com::sun::star::util::MalformedNumberFormatException
            if the format string is invalid.

     */
    com::sun::star::util::Color queryPreviewColorForNumber( [in] string aFormat,
             [in] double fValue,
             [in] com::sun::star::lang::Locale nLocale,
             [in] boolean bAllowEnglish,
             [in] com::sun::star::util::Color aDefaultColor )
            raises( com::sun::star::util::MalformedNumberFormatException );

};

//=============================================================================

}; }; }; };

#endif