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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XLocaleData.idl,v $
  10  * $Revision: 1.20 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_i18n_XLocaleData_idl__
  31 #define __com_sun_star_i18n_XLocaleData_idl__
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34 #include <com/sun/star/lang/Locale.idl>
  35 #include <com/sun/star/i18n/LanguageCountryInfo.idl>
  36 #include <com/sun/star/i18n/Currency.idl>
  37 #include <com/sun/star/i18n/Calendar.idl>
  38 #include <com/sun/star/i18n/LocaleDataItem.idl>
  39 #include <com/sun/star/i18n/ForbiddenCharacters.idl>
  40 #include <com/sun/star/i18n/FormatElement.idl>
  41 #include <com/sun/star/i18n/Implementation.idl>
  42
  43 //============================================================================
  44
  45 module com { module sun { module star { module i18n {
  46
  47 //============================================================================
  48
  49 /**
  50     Access locale specific data as it is defined in XML locale data
  51     files compiled into the binary data libraries liblocaledata*.so
  52     respectively localedata*.dll.
  53
  54     <p> For XML locale data files definitions see <a
  55     href="http://l10n.openoffice.org/source/browse/l10n/i18npool/source/localedata/data/locale.dtd">
  56     the DTD file </a> (or the <a
  57     href="http://l10n.openoffice.org/source/browse/l10n/i18npool/source/localedata_ascii/Attic/locale.dtd">
  58     old Attic version </a> for OOo1.0/SO6.0). </p>
  59  */
  60
  61 published interface XLocaleData: com::sun::star::uno::XInterface
  62 {
  63     //------------------------------------------------------------------------
  64     /** returns the LC_INFO locale information.
  65      */
  66     LanguageCountryInfo getLanguageCountryInfo(
  67                                 [in] com::sun::star::lang::Locale aLocale );
  68
  69     //------------------------------------------------------------------------
  70     /** returns LC_CTYPE separators and markers.
  71      */
  72     LocaleDataItem      getLocaleItem(
  73                                 [in] com::sun::star::lang::Locale aLocale );
  74
  75     //------------------------------------------------------------------------
  76     /** returns all LC_CALENDAR calendars for a locale.
  77      */
  78     sequence<Calendar>  getAllCalendars(
  79                                 [in] com::sun::star::lang::Locale aLocale );
  80
  81     //------------------------------------------------------------------------
  82     /** returns all LC_CURRENCY currencies for a locale.
  83      */
  84     sequence<Currency>  getAllCurrencies(
  85                                 [in] com::sun::star::lang::Locale aLocale );
  86
  87     //------------------------------------------------------------------------
  88     /** returns all LC_FORMAT format elements for a locale.
  89      */
  90     sequence<FormatElement> getAllFormats(
  91                                 [in] com::sun::star::lang::Locale aLocale );
  92
  93     //------------------------------------------------------------------------
  94     /** returns all LC_COLLATION collators for a locale.
  95      */
  96     sequence<Implementation> getCollatorImplementations(
  97                                 [in] com::sun::star::lang::Locale aLocale );
  98
  99     //------------------------------------------------------------------------
 100     /** returns all LC_SEARCH search options for a locale.
 101      */
 102     sequence<string>    getSearchOptions(
 103                                 [in] com::sun::star::lang::Locale aLocale );
 104
 105     //------------------------------------------------------------------------
 106     /** returns all LC_COLLATION collation options for a locale.
 107      */
 108     sequence<string>    getCollationOptions(
 109                                 [in] com::sun::star::lang::Locale aLocale );
 110
 111     //------------------------------------------------------------------------
 112     /** returns all LC_TRANSLITERATION transliterations for a locale.
 113      */
 114     sequence<string>    getTransliterations(
 115                                 [in] com::sun::star::lang::Locale aLocale );
 116
 117     //------------------------------------------------------------------------
 118     /** returns all LC_MISC forbidden charatcers for a locale.
 119      */
 120     ForbiddenCharacters getForbiddenCharacters (
 121                                 [in] com::sun::star::lang::Locale aLocale );
 122
 123     //------------------------------------------------------------------------
 124     /** returns all LC_MISC reserved words for a locale.
 125
 126         @see reservedWords
 127      */
 128     sequence<string>    getReservedWord(
 129                                 [in] com::sun::star::lang::Locale aLocale );
 130
 131     //------------------------------------------------------------------------
 132     /** returns all available locales.
 133      */
 134     sequence<com::sun::star::lang::Locale> getAllInstalledLocaleNames();
 135 };
 136
 137 //============================================================================
 138 }; }; }; };
 139
 140 #endif