1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_i18n_XNumberFormatCode_idl__
25#define __com_sun_star_i18n_XNumberFormatCode_idl__
26
27#ifndef __com_sun_star_lang_Locale_idl__
28#include <com/sun/star/lang/Locale.idl>
29#endif
30#include <com/sun/star/uno/XInterface.idl>
31#include <com/sun/star/i18n/NumberFormatCode.idl>
32
33//=============================================================================
34
35module com { module sun { module star { module i18n {
36
37//=============================================================================
38
39/**
40    Access number format codes defined in locale data.
41 */
42
43published interface XNumberFormatCode : com::sun::star::uno::XInterface
44{
45    //------------------------------------------------------------------------
46    /**
47        returns the default number format code of a specific category
48        (usage group) for a given locale and format length type.
49
50        @param nFormatType
51            one of the constants listed in <type>KNumberFormatType</type>
52
53        @param nFormatUsage
54            one of <type>KNumberFormatUsage</type> values
55     */
56    NumberFormatCode getDefault( [in] short nFormatType,
57                                 [in] short nFormatUsage,
58                                 [in] com::sun::star::lang::Locale rLocale );
59
60    //------------------------------------------------------------------------
61    /**
62        returns the number format pointed to by <em>nFormatIndex</em> for
63        a given locale.
64
65        @param nFormatIndex
66            one of <type>NumberFormatIndex</type> values
67     */
68    NumberFormatCode getFormatCode( [in] short nFormatIndex,
69                                    [in] com::sun::star::lang::Locale rLocale );
70
71    //------------------------------------------------------------------------
72    /**
73        returns all format codes for a given <em>nFormatUsage</em> and locale.
74
75        @param nFormatUsage
76            one of <type>KNumberFormatUsage</type> values
77     */
78    sequence< NumberFormatCode > getAllFormatCode(
79                                [in] short nFormatUsage,
80                                [in] com::sun::star::lang::Locale rLocale );
81
82    //------------------------------------------------------------------------
83    /**
84        returns all format codes for a given locale.
85     */
86    sequence< NumberFormatCode > getAllFormatCodes(
87                                [in] com::sun::star::lang::Locale rLocale );
88
89};
90
91//=============================================================================
92}; }; }; };
93#endif
94