offapi/com/sun/star/i18n/XLocaleData.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_i18n_XLocaleData_idl__
  20 #define __com_sun_star_i18n_XLocaleData_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/Locale.idl>
  24 #include <com/sun/star/i18n/LanguageCountryInfo.idl>
  25 #include <com/sun/star/i18n/Currency.idl>
  26 #include <com/sun/star/i18n/Calendar.idl>
  27 #include <com/sun/star/i18n/LocaleDataItem.idl>
  28 #include <com/sun/star/i18n/ForbiddenCharacters.idl>
  29 #include <com/sun/star/i18n/FormatElement.idl>
  30 #include <com/sun/star/i18n/Implementation.idl>
  31
  32
  33 module com { module sun { module star { module i18n {
  34
  35
  36 /**
  37     Access locale specific data as it is defined in XML locale data
  38     files compiled into the binary data libraries liblocaledata*.so
  39     respectively localedata*.dll.
  40
  41     <p> For XML locale data files definitions see <a
  42     href="http://cgit.freedesktop.org/libreoffice/core/tree/i18npool/source/localedata/data/locale.dtd">
  43     the DTD file</a>. </p>
  44  */
  45
  46 published interface XLocaleData: com::sun::star::uno::XInterface
  47 {
  48     /** returns the LC_INFO locale information.
  49      */
  50     LanguageCountryInfo getLanguageCountryInfo(
  51                                 [in] com::sun::star::lang::Locale aLocale );
  52
  53     /** returns LC_CTYPE separators and markers.
  54      */
  55     LocaleDataItem      getLocaleItem(
  56                                 [in] com::sun::star::lang::Locale aLocale );
  57
  58     /** returns all LC_CALENDAR calendars for a locale.
  59      */
  60     sequence<Calendar>  getAllCalendars(
  61                                 [in] com::sun::star::lang::Locale aLocale );
  62
  63     /** returns all LC_CURRENCY currencies for a locale.
  64      */
  65     sequence<Currency>  getAllCurrencies(
  66                                 [in] com::sun::star::lang::Locale aLocale );
  67
  68     /** returns all LC_FORMAT format elements for a locale.
  69      */
  70     sequence<FormatElement> getAllFormats(
  71                                 [in] com::sun::star::lang::Locale aLocale );
  72
  73     /** returns all LC_COLLATION collators for a locale.
  74      */
  75     sequence<Implementation> getCollatorImplementations(
  76                                 [in] com::sun::star::lang::Locale aLocale );
  77
  78     /** returns all LC_SEARCH search options for a locale.
  79      */
  80     sequence<string>    getSearchOptions(
  81                                 [in] com::sun::star::lang::Locale aLocale );
  82
  83     /** returns all LC_COLLATION collation options for a locale.
  84      */
  85     sequence<string>    getCollationOptions(
  86                                 [in] com::sun::star::lang::Locale aLocale );
  87
  88     /** returns all LC_TRANSLITERATION transliterations for a locale.
  89      */
  90     sequence<string>    getTransliterations(
  91                                 [in] com::sun::star::lang::Locale aLocale );
  92
  93     /** returns all LC_MISC forbidden characters for a locale.
  94      */
  95     ForbiddenCharacters getForbiddenCharacters (
  96                                 [in] com::sun::star::lang::Locale aLocale );
  97
  98     /** returns all LC_MISC reserved words for a locale.
  99
 100         @see reservedWords
 101      */
 102     sequence<string>    getReservedWord(
 103                                 [in] com::sun::star::lang::Locale aLocale );
 104
 105     /** returns all available locales.
 106      */
 107     sequence<com::sun::star::lang::Locale> getAllInstalledLocaleNames();
 108 };
 109
 110 }; }; }; };
 111
 112 #endif
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */