/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_util_XNumberFormatTypes_idl__
#define __com_sun_star_util_XNumberFormatTypes_idl__

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



 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
                NumberFormat constants.
        @param nLocale
            the locale for which the number format is requested.

     */
    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
                 com::sun::star::i18n::NumberFormatIndex
                constants.
        @param nLocale
            the locale for which the key is requested.
     */
    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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
