/*************************************************************************
 *
 *  $RCSfile: XNumberFormatCode.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2001-10-25 10:01:46 $
 *
 *  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_LANG_XNUMBERFORMATCODE_IDL__
#define __COM_SUN_STAR_LANG_XNUMBERFORMATCODE_IDL__

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

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

module com { module sun { module star { module i18n {

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




/**
    Attribute of number format. 

    LeastSignificantBit is used to distinguish between
    positive or negative and second LSB is used for Long or Short format.

    <!-- ER 02.11.00   ? description does not seem to match reality -->
    <!-- JRH:   Meaning unclear still. -->*/
constants KNumberFormatType
{
        const short SHORT                =1;
        const short MEDIUM               =2;
        const short LONG                 =3;
};


constants KNumberFormatUsage
{
        const short DATE                 =1;
        const short TIME                 =2;
        const short DATE_TIME            =3;
        const short FIXED_NUMBER         =4;
        const short FRACTION_NUMBER      =5;
        const short PERCENT_NUMBER       =6;
        const short SCIENTIFIC_NUMBER    =7;
        const short CURRENCY             =8;

};


struct NumberFormatCode {
        /// One of <type>KNumberFormatType</type> values
        short Type;
        /// One of <type>KNumberFormatUsage</type> values
        short Usage;
        /// Format code like DD/MM/YY
        string Code;
        /// Descriptive name of the format for this locale
        string DefaultName;
        /// Message identifier to be used if the name of the format is localized
        string NameID;
        /// Index of the code as defined in <type>NumberFormatIndex</type>
        short Index;
        /// Whether this format is the default format of the usage group
        boolean Default;
};



/**
    This interface provides access to specific number format codes.
 */
interface XNumberFormatCode : com::sun::star::uno::XInterface
{
    /**
         returns the default number format code of a specific category
         (usage group) for a given locale and format length type.

        @param nFormatType
            one of the constants listed in <type>KNumberFormatType</type>

        @param nFormatUsage
             one of <type>KNumberFormatUsage</type> values
     */
    NumberFormatCode getDefault( [in] short nFormatType, [in] short nFormatUsage, [in] com::sun::star::lang::Locale rLocale );

    /**
        returns the number format pointed to by <em>nFormatIndex</em> for
        a given locale.

        @param nFormatIndex
            one of <type>NumberFormatIndex</type> values
     */
    NumberFormatCode getFormatCode( [in] short nFormatIndex, [in] com::sun::star::lang::Locale rLocale );

    /**
        returns all format codes for a given <em>nFormatUsage</em> and locale.

        @param nFormatUsage
            one of <type>KNumberFormatUsage</type> values
     */
    sequence< NumberFormatCode > getAllFormatCode( [in] short nFormatUsage, [in] com::sun::star::lang::Locale rLocale );

    /**
        returns all format codes for a given locale.
     */
    sequence< NumberFormatCode > getAllFormatCodes( [in] com::sun::star::lang::Locale rLocale );

};

//=============================================================================
}; }; }; };
#endif