/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSupportedLocales.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 02:14:18 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__
#define __com_sun_star_linguistic2_XSupportedLocales_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

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

module com { module sun { module star { module linguistic2 {

//=============================================================================
/** Offers information about which languages are supported by the object.

    <P>This interface has to be implemented by
    <type scope="com::sun::star::linguistic2">SpellChecker</type>,
    <type scope="com::sun::star::linguistic2">Hyphenator</type> and
    <type scope="com::sun::star::linguistic2">Thesaurus</type>
    implementations in order to be queried for the languages they
    can use.
    </P>

    @see    <type scope="com::sun::star::lang">Locale</type>
    @see    <type scope="com::sun::star::uno">XInterface</type>
*/
published interface XSupportedLocales : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /**
         @returns
             the sequence of all supported languages.
    */
    sequence<com::sun::star::lang::Locale> getLocales();

    //-------------------------------------------------------------------------
    /**
        @param  aLocale
            specifies the language being checked for support
             by the object.

         @returns
             <TRUE/> if the language is supported, otherwise <FALSE/>.
    */
    boolean hasLocale( [in] com::sun::star::lang::Locale aLocale );
};

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

}; }; }; };

#endif
