xref: /trunk/main/offapi/com/sun/star/i18n/XLocaleData.idl (revision 2c8c108a) 
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_XLocaleData_idl__
25#define __com_sun_star_i18n_XLocaleData_idl__
26
27#include <com/sun/star/uno/XInterface.idl>
28#include <com/sun/star/lang/Locale.idl>
29#include <com/sun/star/i18n/LanguageCountryInfo.idl>
30#include <com/sun/star/i18n/Currency.idl>
31#include <com/sun/star/i18n/Calendar.idl>
32#include <com/sun/star/i18n/LocaleDataItem.idl>
33#include <com/sun/star/i18n/ForbiddenCharacters.idl>
34#include <com/sun/star/i18n/FormatElement.idl>
35#include <com/sun/star/i18n/Implementation.idl>
36
37//============================================================================
38
39module com { module sun { module star { module i18n {
40
41//============================================================================
42
43/**
44    Access locale specific data as it is defined in XML locale data
45    files compiled into the binary data libraries liblocaledata*.so
46    respectively localedata*.dll.
47
48    <p> For XML locale data files definitions see <a
49    href="http://l10n.openoffice.org/source/browse/l10n/i18npool/source/localedata/data/locale.dtd">
50    the DTD file </a> (or the <a
51    href="http://l10n.openoffice.org/source/browse/l10n/i18npool/source/localedata_ascii/Attic/locale.dtd">
52    old Attic version </a> for OOo1.0/SO6.0). </p>
53 */
54
55published interface XLocaleData: com::sun::star::uno::XInterface
56{
57    //------------------------------------------------------------------------
58    /** returns the LC_INFO locale information.
59     */
60    LanguageCountryInfo getLanguageCountryInfo(
61                                [in] com::sun::star::lang::Locale aLocale );
62
63    //------------------------------------------------------------------------
64    /** returns LC_CTYPE separators and markers.
65     */
66    LocaleDataItem      getLocaleItem(
67                                [in] com::sun::star::lang::Locale aLocale );
68
69    //------------------------------------------------------------------------
70    /** returns all LC_CALENDAR calendars for a locale.
71     */
72    sequence<Calendar>  getAllCalendars(
73                                [in] com::sun::star::lang::Locale aLocale );
74
75    //------------------------------------------------------------------------
76    /** returns all LC_CURRENCY currencies for a locale.
77     */
78    sequence<Currency>  getAllCurrencies(
79                                [in] com::sun::star::lang::Locale aLocale );
80
81    //------------------------------------------------------------------------
82    /** returns all LC_FORMAT format elements for a locale.
83     */
84    sequence<FormatElement> getAllFormats(
85                                [in] com::sun::star::lang::Locale aLocale );
86
87    //------------------------------------------------------------------------
88    /** returns all LC_COLLATION collators for a locale.
89     */
90    sequence<Implementation> getCollatorImplementations(
91                                [in] com::sun::star::lang::Locale aLocale );
92
93    //------------------------------------------------------------------------
94    /** returns all LC_SEARCH search options for a locale.
95     */
96    sequence<string>    getSearchOptions(
97                                [in] com::sun::star::lang::Locale aLocale );
98
99    //------------------------------------------------------------------------
100    /** returns all LC_COLLATION collation options for a locale.
101     */
102    sequence<string>    getCollationOptions(
103                                [in] com::sun::star::lang::Locale aLocale );
104
105    //------------------------------------------------------------------------
106    /** returns all LC_TRANSLITERATION transliterations for a locale.
107     */
108    sequence<string>    getTransliterations(
109                                [in] com::sun::star::lang::Locale aLocale );
110
111    //------------------------------------------------------------------------
112    /** returns all LC_MISC forbidden characters for a locale.
113     */
114    ForbiddenCharacters getForbiddenCharacters (
115                                [in] com::sun::star::lang::Locale aLocale );
116
117    //------------------------------------------------------------------------
118    /** returns all LC_MISC reserved words for a locale.
119
120        @see reservedWords
121     */
122    sequence<string>    getReservedWord(
123                                [in] com::sun::star::lang::Locale aLocale );
124
125    //------------------------------------------------------------------------
126    /** returns all available locales.
127     */
128    sequence<com::sun::star::lang::Locale> getAllInstalledLocaleNames();
129};
130
131//============================================================================
132
133}; }; }; };
134
135#endif
136