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