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