xref: /trunk/main/offapi/com/sun/star/linguistic2/XSupportedLocales.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#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