1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_sheet_XAddIn_idl__ 29#define __com_sun_star_sheet_XAddIn_idl__ 30 31#ifndef __com_sun_star_lang_XLocalizable_idl__ 32#include <com/sun/star/lang/XLocalizable.idl> 33#endif 34 35//============================================================================= 36 37module com { module sun { module star { module sheet { 38 39//============================================================================= 40 41/** gives access to function descriptions and user-visible names. 42 */ 43published interface XAddIn: com::sun::star::lang::XLocalizable 44{ 45 //------------------------------------------------------------------------- 46 47 /** returns the internal function name for an user-visible name. 48 49 <p>The user-visible name of a function is the name shown to the 50 user. It may be translated to the current language of the AddIn, 51 so it is never stored in files. It should be a single word and is 52 used when entering or displaying formulas.</p> 53 54 <p>Attention: The method name contains a spelling error. Due to 55 compatibility reasons the name cannot be changed.</p> 56 57 @param aDisplayName 58 the user-visible name of a function. 59 60 @returns 61 the exact name of the method within its interface. 62 63 */ 64 string getProgrammaticFuntionName( [in] string aDisplayName ); 65 66 //------------------------------------------------------------------------- 67 68 /** returns the user-visible function name for an internal name. 69 70 <p>The user-visible name of a function is the name shown to the 71 user. It may be translated to the current language of the AddIn, 72 so it is never stored in files. It should be a single word and is 73 used when entering or displaying formulas.</p> 74 75 @param aProgrammaticName 76 is the exact name of a method within its interface. 77 78 @returns 79 the user-visible name of the specified function. 80 */ 81 string getDisplayFunctionName( [in] string aProgrammaticName ); 82 83 //------------------------------------------------------------------------- 84 85 /** returns the description of a function. 86 87 <p>The description is shown to the user when selecting functions. 88 It may be translated to the current language of the AddIn.</p> 89 90 @param aProgrammaticName 91 is the exact name of a method within its interface. 92 93 @returns 94 the description of the specified function. 95 */ 96 string getFunctionDescription( [in] string aProgrammaticName ); 97 98 //------------------------------------------------------------------------- 99 100 /** returns the user-visible name of the specified argument. 101 102 <p>The argument name is shown to the user when prompting for 103 arguments. It should be a single word and may be translated 104 to the current language of the AddIn.</p> 105 106 @param aProgrammaticFunctionName 107 is the exact name of a method within its interface. 108 109 @param nArgument 110 the index of the argument (0-based). 111 112 @returns 113 the user-visible name of the specified argument. 114 */ 115 string getDisplayArgumentName( 116 [in] string aProgrammaticFunctionName, 117 [in] long nArgument ); 118 119 //------------------------------------------------------------------------- 120 121 /** returns the description of the specified argument. 122 123 <p>The argument description is shown to the user when prompting 124 for arguments. It may be translated to the current language of 125 the AddIn.</p> 126 127 @param aProgrammaticFunctionName 128 is the exact name of a method within its interface. 129 130 @param nArgument 131 the index of the argument (0-based). 132 133 @returns 134 the description of the specified argument. 135 */ 136 string getArgumentDescription( 137 [in] string aProgrammaticFunctionName, 138 [in] long nArgument ); 139 140 //------------------------------------------------------------------------- 141 142 /** returns the programmatic name of the category the function 143 belongs to. 144 145 <p>The category name is used to group similar functions together. 146 The programmatic category name should always be in English, it is 147 never shown to the user. 148 It should be one of the following names if the function falls into 149 the corresponding category.</p> 150 151 <dl> 152 <dt>Database</dt> 153 <dd>for functions that operate with data organized in tabular form 154 like databases.</dd> 155 156 <dt>Date&Time</dt> 157 <dd>for functions that deal with date or time values.</dd> 158 159 <dt>Financial</dt> 160 <dd>for functions that solve financial problems.</dd> 161 162 <dt>Information</dt> 163 <dd>for functions that provide information about cells.</dd> 164 165 <dt>Logical</dt> 166 <dd>for functions that deal with logical expressions.</dd> 167 168 <dt>Mathematical</dt> 169 <dd>for mathematical functions.</dd> 170 171 <dt>Matrix</dt> 172 <dd>for matrix functions.</dd> 173 174 <dt>Statistical</dt> 175 <dd>for statistical functions.</dd> 176 177 <dt>Spreadsheet</dt> 178 <dd>for functions that deal with cell ranges.</dd> 179 180 <dt>Text</dt> 181 <dd>for functions that deal with text strings.</dd> 182 183 <dt>Add-In</dt> 184 <dd>for additional functions.</dd> 185 </dl> 186 187 @param aProgrammaticFunctionName 188 is the exact name of a method within its interface. 189 190 @returns 191 the category name the specified function belongs to. 192 */ 193 string getProgrammaticCategoryName( [in] string aProgrammaticFunctionName ); 194 195 //------------------------------------------------------------------------- 196 197 /** returns the user-visible name of the category the function 198 belongs to. 199 200 <p>This is used when category names are shown to the user.</p> 201 202 @param aProgrammaticFunctionName 203 is the exact name of a method within its interface. 204 205 @returns 206 the user-visible category name the specified function 207 belongs to. 208 */ 209 string getDisplayCategoryName( [in] string aProgrammaticFunctionName ); 210 211}; 212 213//============================================================================= 214 215}; }; }; }; 216 217#endif 218 219