summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/lang/Locale.idl
blob: 364f0b0c86a2ad10cfe84db2e5b5dc047e68f81e (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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*************************************************************************
 *
 *  $RCSfile: Locale.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2002-12-10 10:31:32 $
 *
 *  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_Locale_idl__
#define __com_sun_star_lang_Locale_idl__

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


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

module com {  module sun {  module star {  module lang {

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

// DocMerge from xml: struct com::sun::star::lang::Locale
/** object represents a specific geographical, political, or cultural region.

    <p>An operation that requires a <code>Locale</code> to perform
    its task is called <em>locale-sensitive</em> and uses the
    <code>Locale</code> to tailor information for the user. For example,
    displaying a number is a locale-sensitive operation; the number
    should be formatted according to the customs/conventions of the
    user's native country, region, or culture.  </p>

    <p> Because a <code>Locale</code> object is just an identifier for a
    region, no validity check is performed.  If you want to see whether
    particular resources are available for the <code>Locale</code>, use
    the <method scope="com::sun::star::resource">XLocale::getAvailableLocales</method> method to ask for the
    locales it supports.</p>

    <p> <strong>Note:</strong> When you ask for a resource for a
    particular locale, you get the best available match, not necessarily
    precisely what you asked for. For more information, see
    <type scope="com::sun::star::resource">XResourceBundle</type>.</p>

    <p> Each implementation that performs locale-sensitive operations
    allows you to get all the available objects of that type. Use the
    <typed scope="com::sun::star::resource">XLocale</type> interface to set the locale. </p>
 */
struct Locale
{
    // DocMerge from xml: field com::sun::star::lang::Locale::Language
    /** specifies an <strong>ISO Language Code</strong>.

        <p>These codes are the lower-case two-letter codes as defined by
        ISO-639. You can find a full list of these codes at a number of
        sites, such as: <br>
        <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">
        <code>http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</code></a>.
        </p>

        <p>If this field contains an empty string, the meaning depends on the
        context.</p>
     */
    string Language;

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

    // DocMerge from xml: field com::sun::star::lang::Locale::Country
    /** specifies an <strong>ISO Country Code.</strong>

        <p>These codes are the upper-case two-letter codes as
        defined by ISO-3166.  You can find a full list of these codes at a
        number of sites, such as: <br>
        <a href="http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html">
        <code>http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html</code></a>.
        </p>

        <p>If this field contains an empty string, the meaning depends on the
        context.</p>
     */
    string Country;

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

    // DocMerge from xml: field com::sun::star::lang::Locale::Variant
    /** contains a variant of the locale; codes are vendor and
        browser-specific.

        <p>For example, use WIN for Windows, MAC for Macintosh, and POSIX
        for POSIX. Wherever there are two variants, separate them with an
        underscore, and put the most important one first. For example, a
        traditional Spanish collation might construct a locale with parameters
        for language, country and variant as: "es", "ES", "Traditional_WIN".</p>
     */
    string Variant;

};


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

}; }; }; };

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

    $Log: not supported by cvs2svn $
    Revision 1.5  2000/12/13 15:47:00  mi
    symtactical documentation and minor semantic documentation flaws fixed

    Revision 1.4  2000/11/08 12:28:41  mi
    moved from api

    Revision 1.4  2000/10/29 16:19:44  er
    moved all types except struct Locale to ../i18n/XLocale.idl

    Revision 1.3  2000/10/18 10:12:56  mi
    well formed documentation in struict Locale

    Revision 1.2  2000/10/13 17:35:02  er
    added enums and constants

    Revision 1.1.1.1  2000/09/18 23:35:24  hjs
    initial import

    Revision 1.7  2000/09/11 11:52:32  mi
    documentation merged from XML

    Revision 1.5  2000/06/29 14:39:46  sse
    New UNO interface for accessing locale data from XML

    Revision 1.4  2000/03/09 12:36:14  mi
    #70728# missing documentation

    Revision 1.3  2000/02/23 11:41:15  mi
    results from proofreading in layouted version

    Revision 1.2  2000/02/07 11:24:38  mi
    zu #70728# missing documentation marked

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


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