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