offapi/com/sun/star/linguistic2/XSupportedLocales.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: XSupportedLocales.idl,v $
  10  * $Revision: 1.11 $
  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_XSupportedLocales_idl__
  31 #define __com_sun_star_linguistic2_XSupportedLocales_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_Locale_idl__
  38 #include <com/sun/star/lang/Locale.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module linguistic2 {
  48
  49 //=============================================================================
  50 /** Offers information about which languages are supported by the object.
  51
  52     <P>This interface has to be implemented by
  53     <type scope="com::sun::star::linguistic2">SpellChecker</type>,
  54     <type scope="com::sun::star::linguistic2">Hyphenator</type> and
  55     <type scope="com::sun::star::linguistic2">Thesaurus</type>
  56     implementations in order to be queried for the languages they
  57     can use.
  58     </P>
  59
  60     @see    <type scope="com::sun::star::lang">Locale</type>
  61     @see    <type scope="com::sun::star::uno">XInterface</type>
  62 */
  63 published interface XSupportedLocales : com::sun::star::uno::XInterface
  64 {
  65     //-------------------------------------------------------------------------
  66     /**
  67          @returns
  68              the sequence of all supported languages.
  69     */
  70     sequence<com::sun::star::lang::Locale> getLocales();
  71
  72     //-------------------------------------------------------------------------
  73     /**
  74         @param  aLocale
  75             specifies the language being checked for support
  76              by the object.
  77
  78          @returns
  79              <TRUE/> if the language is supported, otherwise <FALSE/>.
  80     */
  81     boolean hasLocale( [in] com::sun::star::lang::Locale aLocale );
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif