offapi/com/sun/star/linguistic2/XAvailableLocales.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: XAvailableLocales.idl,v $
  10  * $Revision: 1.7 $
  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_linguistic2_XAvailableLocales_idl__
  31 #define __com_sun_star_linguistic2_XAvailableLocales_idl__
  32
  33
  34 #ifndef __com_sun_star_lang_Locale_idl__
  35 #include <com/sun/star/lang/Locale.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module linguistic2 {
  42
  43 //=============================================================================
  44 /** retrieves the list of available languages.
  45 */
  46 published interface XAvailableLocales : com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49     /** retrieve the list of supported languages (Locales).
  50
  51         @see    <type scope"com::sun::star::linguistic2">XSupportedLocales</type>
  52
  53         @param aServiceName
  54             the name of the service to get the list of available Locales for.
  55         @return
  56             the list of locales supported by the whole of all registered
  57             implementations of that service. The sequence will be empty
  58             if there is no such language or the service is not known.
  59     */
  60     sequence< com::sun::star::lang::Locale > getAvailableLocales(
  61         [in] string                                             aServiceName );
  62 };
  63
  64 //=============================================================================
  65
  66 }; }; }; };
  67
  68 #endif
  69