summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/i18n/XLocaleData.idl
blob: d71a2a937c82e15bdd0c610065e533f419117f35 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_i18n_XLocaleData_idl__
#define __com_sun_star_i18n_XLocaleData_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/i18n/LanguageCountryInfo.idl>
#include <com/sun/star/i18n/Currency.idl>
#include <com/sun/star/i18n/Calendar.idl>
#include <com/sun/star/i18n/LocaleDataItem.idl>
#include <com/sun/star/i18n/ForbiddenCharacters.idl>
#include <com/sun/star/i18n/FormatElement.idl>
#include <com/sun/star/i18n/Implementation.idl>

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

module com { module sun { module star { module i18n {

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

/**
    Access locale specific data as it is defined in XML locale data
    files compiled into the binary data libraries liblocaledata*.so
    respectively localedata*.dll.

    <p> For XML locale data files definitions see <a
    href="http://l10n.openoffice.org/source/browse/l10n/i18npool/source/localedata/data/locale.dtd">
    the DTD file </a> (or the <a
    href="http://l10n.openoffice.org/source/browse/l10n/i18npool/source/localedata_ascii/Attic/locale.dtd">
    old Attic version </a> for OOo1.0/SO6.0). </p>
 */

published interface XLocaleData: com::sun::star::uno::XInterface
{
    //------------------------------------------------------------------------
    /** returns the LC_INFO locale information.
     */
    LanguageCountryInfo getLanguageCountryInfo(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns LC_CTYPE separators and markers.
     */
    LocaleDataItem      getLocaleItem(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all LC_CALENDAR calendars for a locale.
     */
    sequence<Calendar>  getAllCalendars(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all LC_CURRENCY currencies for a locale.
     */
    sequence<Currency>  getAllCurrencies(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all LC_FORMAT format elements for a locale.
     */
    sequence<FormatElement> getAllFormats(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all LC_COLLATION collators for a locale.
     */
    sequence<Implementation> getCollatorImplementations(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all LC_SEARCH search options for a locale.
     */
    sequence<string>    getSearchOptions(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all LC_COLLATION collation options for a locale.
     */
    sequence<string>    getCollationOptions(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all LC_TRANSLITERATION transliterations for a locale.
     */
    sequence<string>    getTransliterations(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all LC_MISC forbidden charatcers for a locale.
     */
    ForbiddenCharacters getForbiddenCharacters (
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all LC_MISC reserved words for a locale.

        @see reservedWords
     */
    sequence<string>    getReservedWord(
                                [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** returns all available locales.
     */
    sequence<com::sun::star::lang::Locale> getAllInstalledLocaleNames();
};

//============================================================================
}; }; }; };

#endif