offapi/com/sun/star/sheet/XCompatibilityNames.idl

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