summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/util/XNumberFormatTypes.idl
blob: 334e2bbdf847c1dfb77f0d5a493986012abf9820 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XNumberFormatTypes.idl,v $
 * $Revision: 1.9 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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