1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XCompatibilityNames_idl__
29#define __com_sun_star_sheet_XCompatibilityNames_idl__
30
31#ifndef __com_sun_star_sheet_LocalizedName_idl__
32#include <com/sun/star/sheet/LocalizedName.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** gives access to the sequence of compatibility names for an Addin
42	function.
43 */
44published interface XCompatibilityNames: com::sun::star::uno::XInterface
45{
46	/** returns the compatibility names of the specified function.
47
48		<p>Compatibility names are localized names of AddIn functions that
49		are used to import files from other applications.</p>
50
51		<p>If on import a localized function name is read, this list of
52		compatibility names is used to find the internal name of the
53		function. The current locale may differ from the locale used in
54		the imported file, so the method
55		<member>XAddIn::getProgrammaticFuntionName</member> cannot be used
56		here.</p>
57
58		<p>The order inside the sequence of compatibility names is used to
59		prioritize the names. Initially the first compatibility name of
60		each function is compared to the imported name (each function may
61		provide a sequence of compatibility names - the first entry of all
62		sequences is used). If no entry is equal, the second entry of each
63		sequence is used and so on.</p>
64
65		<p>If a locale is not present in the sequence of compatibility names,
66		the first entry of the sequence is used. So the method should return
67		a sequence which contains first the entry representing the current
68		locale.<TRUE/></p>
69
70		@param aProgrammaticName
71			is the exact name of a method within its interface.
72	 */
73	sequence< com::sun::star::sheet::LocalizedName >
74		getCompatibilityNames( [in] string aProgrammaticName );
75};
76
77//=============================================================================
78
79}; }; }; };
80
81#endif
82
83