/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XNumberFormatTypes.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 09:10:56 $
 *
 *  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_XNumberFormatTypes_idl__
#define __com_sun_star_util_XNumberFormatTypes_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif


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

 module com {  module sun {  module star {  module util {

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

/** represents functions to get specific, predefined number formats.
 */
published interface XNumberFormatTypes: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** @returns
                the key of the standard format for a locale.
     */
    long getStandardIndex( [in] com::sun::star::lang::Locale nLocale );

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

    /** @returns
                the key of the standard format within a specified type for a given locale.

                @param nType
                the type of the number format. Must be one of the
                <type>NumberFormat</type> constants.
     */
    long getStandardFormat( [in] short nType,
             [in] com::sun::star::lang::Locale nLocale );

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

    /** @returns
                the key of a built-in format for a locale:

                @param  nIndex
                the index of the wanted number format within the formats for
                the given locale. One of the
                 <type scope="com::sun::star::i18n">NumberFormatIndex</type>
                constants.
     */
    long getFormatIndex( [in] short nIndex,
             [in] com::sun::star::lang::Locale nLocale );

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

    /** verifies if one type of number format is compatible with another type.
     */
    boolean isTypeCompatible( [in] short nOldType,
             [in] short nNewType );

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

    /** @returns
                the index of the converted number format if successful,
                the old index if the number format could not be converted.

                @param nKey
                index of the old number format

                @param nLocale
                the locale to which the number format is converted
     */
    long getFormatForLocale( [in] long nKey,
             [in] com::sun::star::lang::Locale nLocale );

};

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

}; }; }; };

#endif

