summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/linguistic2/XAvailableLocales.idl
blob: 97d75f7c0937ab7204512e07225f88e1b91a816d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_linguistic2_XAvailableLocales_idl__
#define __com_sun_star_linguistic2_XAvailableLocales_idl__


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


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

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

//=============================================================================
/** retrieves the list of available languages.
*/
published interface XAvailableLocales : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** retrieve the list of supported languages (Locales).

        @see    <type scope"com::sun::star::linguistic2">XSupportedLocales</type>

        @param aServiceName
            the name of the service to get the list of available Locales for.
        @return
            the list of locales supported by the whole of all registered
            implementations of that service. The sequence will be empty
            if there is no such language or the service is not known.
    */
    sequence< com::sun::star::lang::Locale > getAvailableLocales(
        [in] string                         aServiceName );
};

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

}; }; }; };

#endif