/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XNumberFormats.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 09:11:17 $
 *
 *  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_XNumberFormats_idl__
#define __com_sun_star_util_XNumberFormats_idl__

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

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.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


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

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

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

/** provides access to multiple <type>NumberFormat</type>s.
 */
published interface XNumberFormats: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** @returns
                    a readonly <type>NumberFormatProperties</type>.
     */
    com::sun::star::beans::XPropertySet getByKey( [in] long nKey );

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

    /** @returns
                    a sequence of the keys of all number formats with the specified type and language.

                @param  nType
                        the type of number formats to return. Must be one of the
                        <type>NumberFormat</type> constants.

                @param  nLanguage
                        the language of number formats to return.

                @param  bCreate
                        <TRUE/>: create new entries if no formats for the selected language exist<BR>
                        <FALSE/>: return an empty list if no formats for the selected language exist
     */
    sequence<long> queryKeys( [in] short nType,
             [in] com::sun::star::lang::Locale nLocale,
             [in] boolean bCreate );

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

    /** finds a number format by its format string and returns its key.
     */
    long queryKey( [in] string aFormat,
             [in] com::sun::star::lang::Locale nLocale,
             [in] boolean bScan );

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

    /** adds a new number format to the list, using a format string.
     */
    long addNew( [in] string aFormat,
             [in] com::sun::star::lang::Locale nLocale )
            raises( com::sun::star::util::MalformedNumberFormatException );

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

    /** adds a new number format to the list, using a format
        string in a different locale than the desired locale of the
        resulting number format.
     */
    long addNewConverted( [in] string aFormat,
             [in] com::sun::star::lang::Locale nLocale,
             [in] com::sun::star::lang::Locale nNewLocale )
            raises( com::sun::star::util::MalformedNumberFormatException );

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

    /** removes a number format from the list.
     */
    void removeByKey( [in] long nKey );

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

    /** generates a format string from several parameters without
        creating an actual number format.
     */
    string generateFormat( [in] long nBaseKey,
             [in] com::sun::star::lang::Locale nLocale,
             [in] boolean bThousands,
             [in] boolean bRed,
             [in] short nDecimals,
             [in] short nLeading );

};

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

}; }; }; };

#endif

