xref: /AOO41X/main/offapi/com/sun/star/linguistic2/XSupportedLocales.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__
24#define __com_sun_star_linguistic2_XSupportedLocales_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_Locale_idl__
31#include <com/sun/star/lang/Locale.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module linguistic2 {
41
42//=============================================================================
43/** Offers information about which languages are supported by the object.
44
45    <P>This interface has to be implemented by
46    <type scope="com::sun::star::linguistic2">SpellChecker</type>,
47    <type scope="com::sun::star::linguistic2">Hyphenator</type> and
48    <type scope="com::sun::star::linguistic2">Thesaurus</type>
49    implementations in order to be queried for the languages they
50    can use.
51    </P>
52
53    @see    <type scope="com::sun::star::lang">Locale</type>
54    @see    <type scope="com::sun::star::uno">XInterface</type>
55*/
56published interface XSupportedLocales : com::sun::star::uno::XInterface
57{
58    //-------------------------------------------------------------------------
59    /**
60        @returns
61            the sequence of all supported languages.
62    */
63    sequence<com::sun::star::lang::Locale> getLocales();
64
65    //-------------------------------------------------------------------------
66    /**
67        @param  aLocale
68            specifies the language being checked for support
69            by the object.
70
71        @returns
72            <TRUE/> if the language is supported, otherwise <FALSE/>.
73    */
74    boolean hasLocale( [in] com::sun::star::lang::Locale aLocale );
75};
76
77//=============================================================================
78
79}; }; }; };
80
81#endif
82