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
24#ifndef __com_sun_star_sheet_XCompatibilityNames_idl__
25#define __com_sun_star_sheet_XCompatibilityNames_idl__
26
27#ifndef __com_sun_star_sheet_LocalizedName_idl__
28#include <com/sun/star/sheet/LocalizedName.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module sheet {
34
35//=============================================================================
36
37/** gives access to the sequence of compatibility names for an Addin
38	function.
39 */
40published interface XCompatibilityNames: com::sun::star::uno::XInterface
41{
42	/** returns the compatibility names of the specified function.
43
44		<p>Compatibility names are localized names of AddIn functions that
45		are used to import files from other applications.</p>
46
47		<p>If on import a localized function name is read, this list of
48		compatibility names is used to find the internal name of the
49		function. The current locale may differ from the locale used in
50		the imported file, so the method
51		<member>XAddIn::getProgrammaticFuntionName</member> cannot be used
52		here.</p>
53
54		<p>The order inside the sequence of compatibility names is used to
55		prioritize the names. Initially the first compatibility name of
56		each function is compared to the imported name (each function may
57		provide a sequence of compatibility names - the first entry of all
58		sequences is used). If no entry is equal, the second entry of each
59		sequence is used and so on.</p>
60
61		<p>If a locale is not present in the sequence of compatibility names,
62		the first entry of the sequence is used. So the method should return
63		a sequence which contains first the entry representing the current
64		locale.<TRUE/></p>
65
66		@param aProgrammaticName
67			is the exact name of a method within its interface.
68	 */
69	sequence< com::sun::star::sheet::LocalizedName >
70		getCompatibilityNames( [in] string aProgrammaticName );
71};
72
73//=============================================================================
74
75}; }; }; };
76
77#endif
78
79