offapi/com/sun/star/sheet/XAddIn.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: XAddIn.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_XAddIn_idl__
  32 #define __com_sun_star_sheet_XAddIn_idl__
  33
  34 #ifndef __com_sun_star_lang_XLocalizable_idl__
  35 #include <com/sun/star/lang/XLocalizable.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** gives access to function descriptions and user-visible names.
  45  */
  46 published interface XAddIn: com::sun::star::lang::XLocalizable
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** returns the internal function name for an user-visible name.
  51
  52         <p>The user-visible name of a function is the name shown to the
  53         user. It may be translated to the current language of the AddIn,
  54         so it is never stored in files. It should be a single word and is
  55         used when entering or displaying formulas.</p>
  56
  57         <p>Attention: The method name contains a spelling error. Due to
  58         compatibility reasons the name cannot be changed.</p>
  59
  60         @param aDisplayName
  61             the user-visible name of a function.
  62
  63         @returns
  64             the exact name of the method within its interface.
  65
  66      */
  67     string getProgrammaticFuntionName( [in] string aDisplayName );
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** returns the user-visible function name for an internal name.
  72
  73         <p>The user-visible name of a function is the name shown to the
  74         user. It may be translated to the current language of the AddIn,
  75         so it is never stored in files. It should be a single word and is
  76         used when entering or displaying formulas.</p>
  77
  78         @param aProgrammaticName
  79             is the exact name of a method within its interface.
  80
  81         @returns
  82             the user-visible name of the specified function.
  83      */
  84     string getDisplayFunctionName( [in] string aProgrammaticName );
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** returns the description of a function.
  89
  90         <p>The description is shown to the user when selecting functions.
  91         It may be translated to the current language of the AddIn.</p>
  92
  93         @param aProgrammaticName
  94             is the exact name of a method within its interface.
  95
  96         @returns
  97             the description of the specified function.
  98      */
  99     string getFunctionDescription( [in] string aProgrammaticName );
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** returns the user-visible name of the specified argument.
 104
 105         <p>The argument name is shown to the user when prompting for
 106         arguments. It should be a single word and may be translated
 107         to the current language of the AddIn.</p>
 108
 109         @param aProgrammaticFunctionName
 110             is the exact name of a method within its interface.
 111
 112         @param nArgument
 113             the index of the argument (0-based).
 114
 115         @returns
 116             the user-visible name of the specified argument.
 117      */
 118     string getDisplayArgumentName(
 119             [in] string aProgrammaticFunctionName,
 120             [in] long nArgument );
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** returns the description of the specified argument.
 125
 126         <p>The argument description is shown to the user when prompting
 127         for arguments. It may be translated to the current language of
 128         the AddIn.</p>
 129
 130         @param aProgrammaticFunctionName
 131             is the exact name of a method within its interface.
 132
 133         @param nArgument
 134             the index of the argument (0-based).
 135
 136         @returns
 137             the description of the specified argument.
 138      */
 139     string getArgumentDescription(
 140             [in] string aProgrammaticFunctionName,
 141             [in] long nArgument );
 142
 143     //-------------------------------------------------------------------------
 144
 145     /** returns the programmatic name of the category the function
 146         belongs to.
 147
 148         <p>The category name is used to group similar functions together.
 149         The programmatic category name should always be in English, it is
 150         never shown to the user.
 151         It should be one of the following names if the function falls into
 152         the corresponding category.</p>
 153
 154         <dl>
 155         <dt>Database</dt>
 156         <dd>for functions that operate with data organized in tabular form
 157         like databases.</dd>
 158
 159         <dt>Date&amp;Time</dt>
 160         <dd>for functions that deal with date or time values.</dd>
 161
 162         <dt>Financial</dt>
 163         <dd>for functions that solve financial problems.</dd>
 164
 165         <dt>Information</dt>
 166         <dd>for functions that provide information about cells.</dd>
 167
 168         <dt>Logical</dt>
 169         <dd>for functions that deal with logical expressions.</dd>
 170
 171         <dt>Mathematical</dt>
 172         <dd>for mathematical functions.</dd>
 173
 174         <dt>Matrix</dt>
 175         <dd>for matrix functions.</dd>
 176
 177         <dt>Statistical</dt>
 178         <dd>for statistical functions.</dd>
 179
 180         <dt>Spreadsheet</dt>
 181         <dd>for functions that deal with cell ranges.</dd>
 182
 183         <dt>Text</dt>
 184         <dd>for functions that deal with text strings.</dd>
 185
 186         <dt>Add-In</dt>
 187         <dd>for additional functions.</dd>
 188         </dl>
 189
 190         @param aProgrammaticFunctionName
 191             is the exact name of a method within its interface.
 192
 193         @returns
 194             the category name the specified function belongs to.
 195      */
 196     string getProgrammaticCategoryName( [in] string aProgrammaticFunctionName );
 197
 198     //-------------------------------------------------------------------------
 199
 200     /** returns the user-visible name of the category the function
 201         belongs to.
 202
 203         <p>This is used when category names are shown to the user.</p>
 204
 205         @param aProgrammaticFunctionName
 206             is the exact name of a method within its interface.
 207
 208         @returns
 209             the user-visible category name the specified function
 210             belongs to.
 211      */
 212     string getDisplayCategoryName( [in] string aProgrammaticFunctionName );
 213
 214 };
 215
 216 //=============================================================================
 217
 218 }; }; }; };
 219
 220 #endif
 221