summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/util/XNumberFormatTypes.idl
blob: 6803e48e81fd87a71cd49556283d5397db5c4421 (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*************************************************************************
 *
 *  $RCSfile: XNumberFormatTypes.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:18:55 $
 *
 *  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_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 {

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

// DocMerge from xml: interface com::sun::star::util::XNumberFormatTypes
/** represents functions to get specific predefined number formats.
 */
[ uik(E2280407-33D6-11D1-AABE00A0-249D5590), ident( "XNumberFormatTypes", 1.0 ) ]
interface XNumberFormatTypes: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::util::XNumberFormatTypes::getStandardIndex
    /** @returns
                the key of the standard format for a locale.
     */
    long getStandardIndex( [in] com::sun::star::lang::Locale nLocale );

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

    // DocMerge from idl: method com::sun::star::util::XNumberFormatTypes::getStandardFormat
    /** @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.
     */
    long getStandardFormat( [in] short nType,
             [in] com::sun::star::lang::Locale nLocale );

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

    // DocMerge from idl: method com::sun::star::util::XNumberFormatTypes::getFormatIndex
    /** @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 );

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

    // DocMerge from xml: method com::sun::star::util::XNumberFormatTypes::isTypeCompatible
    /** verifies if one type of number format is compatible with another type.
     */
    boolean isTypeCompatible( [in] short nOldType,
             [in] short nNewType );

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

    // DocMerge from idl: method com::sun::star::util::XNumberFormatTypes::getFormatForLocale
    /** @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 );

};

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

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.2  2000/11/02 20:34:33  er
    getFormatIndex: added a comment pointing to <type scope=com::sun::star::i18n>NumberFormatIndex</type>

    Revision 1.1.1.1  2000/09/18 23:36:20  hjs
    initial import

    Revision 1.4  2000/09/11 11:53:06  mi
    documentation merged from XML

    Revision 1.2  2000/01/28 15:01:52  mi
    #72210# Locale instead of Language in NumberFormatter

    Revision 1.1.1.1  1999/11/11 09:48:46  jsc
    new


=============================================================================*/
#endif