xref: /trunk/main/offapi/com/sun/star/sheet/XCompatibilityNames.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XCompatibilityNames_idl__
25cdf0e10cSrcweir#define __com_sun_star_sheet_XCompatibilityNames_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_sheet_LocalizedName_idl__
28cdf0e10cSrcweir#include <com/sun/star/sheet/LocalizedName.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir//=============================================================================
32cdf0e10cSrcweir
33cdf0e10cSrcweirmodule com {  module sun {  module star {  module sheet {
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweir/** gives access to the sequence of compatibility names for an Addin
38cdf0e10cSrcweir    function.
39cdf0e10cSrcweir */
40cdf0e10cSrcweirpublished interface XCompatibilityNames: com::sun::star::uno::XInterface
41cdf0e10cSrcweir{
42cdf0e10cSrcweir    /** returns the compatibility names of the specified function.
43cdf0e10cSrcweir
44cdf0e10cSrcweir        <p>Compatibility names are localized names of AddIn functions that
45cdf0e10cSrcweir        are used to import files from other applications.</p>
46cdf0e10cSrcweir
47cdf0e10cSrcweir        <p>If on import a localized function name is read, this list of
48cdf0e10cSrcweir        compatibility names is used to find the internal name of the
49cdf0e10cSrcweir        function. The current locale may differ from the locale used in
50cdf0e10cSrcweir        the imported file, so the method
51cdf0e10cSrcweir        <member>XAddIn::getProgrammaticFuntionName</member> cannot be used
52cdf0e10cSrcweir        here.</p>
53cdf0e10cSrcweir
54cdf0e10cSrcweir        <p>The order inside the sequence of compatibility names is used to
55cdf0e10cSrcweir        prioritize the names. Initially the first compatibility name of
56cdf0e10cSrcweir        each function is compared to the imported name (each function may
57cdf0e10cSrcweir        provide a sequence of compatibility names - the first entry of all
58cdf0e10cSrcweir        sequences is used). If no entry is equal, the second entry of each
59cdf0e10cSrcweir        sequence is used and so on.</p>
60cdf0e10cSrcweir
61cdf0e10cSrcweir        <p>If a locale is not present in the sequence of compatibility names,
62cdf0e10cSrcweir        the first entry of the sequence is used. So the method should return
63cdf0e10cSrcweir        a sequence which contains first the entry representing the current
64cdf0e10cSrcweir        locale.<TRUE/></p>
65cdf0e10cSrcweir
66cdf0e10cSrcweir        @param aProgrammaticName
67cdf0e10cSrcweir            is the exact name of a method within its interface.
68cdf0e10cSrcweir     */
69cdf0e10cSrcweir    sequence< com::sun::star::sheet::LocalizedName >
70cdf0e10cSrcweir        getCompatibilityNames( [in] string aProgrammaticName );
71cdf0e10cSrcweir};
72cdf0e10cSrcweir
73cdf0e10cSrcweir//=============================================================================
74cdf0e10cSrcweir
75cdf0e10cSrcweir}; }; }; };
76cdf0e10cSrcweir
77cdf0e10cSrcweir#endif
78