/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef __com_sun_star_sheet_XAddIn_idl__ #define __com_sun_star_sheet_XAddIn_idl__ #ifndef __com_sun_star_lang_XLocalizable_idl__ #include #endif //============================================================================= module com { module sun { module star { module sheet { //============================================================================= /** gives access to function descriptions and user-visible names. */ published interface XAddIn: com::sun::star::lang::XLocalizable { //------------------------------------------------------------------------- /** returns the internal function name for an user-visible name.

The user-visible name of a function is the name shown to the user. It may be translated to the current language of the AddIn, so it is never stored in files. It should be a single word and is used when entering or displaying formulas.

Attention: The method name contains a spelling error. Due to compatibility reasons the name cannot be changed.

@param aDisplayName the user-visible name of a function. @returns the exact name of the method within its interface. */ string getProgrammaticFuntionName( [in] string aDisplayName ); //------------------------------------------------------------------------- /** returns the user-visible function name for an internal name.

The user-visible name of a function is the name shown to the user. It may be translated to the current language of the AddIn, so it is never stored in files. It should be a single word and is used when entering or displaying formulas.

@param aProgrammaticName is the exact name of a method within its interface. @returns the user-visible name of the specified function. */ string getDisplayFunctionName( [in] string aProgrammaticName ); //------------------------------------------------------------------------- /** returns the description of a function.

The description is shown to the user when selecting functions. It may be translated to the current language of the AddIn.

@param aProgrammaticName is the exact name of a method within its interface. @returns the description of the specified function. */ string getFunctionDescription( [in] string aProgrammaticName ); //------------------------------------------------------------------------- /** returns the user-visible name of the specified argument.

The argument name is shown to the user when prompting for arguments. It should be a single word and may be translated to the current language of the AddIn.

@param aProgrammaticFunctionName is the exact name of a method within its interface. @param nArgument the index of the argument (0-based). @returns the user-visible name of the specified argument. */ string getDisplayArgumentName( [in] string aProgrammaticFunctionName, [in] long nArgument ); //------------------------------------------------------------------------- /** returns the description of the specified argument.

The argument description is shown to the user when prompting for arguments. It may be translated to the current language of the AddIn.

@param aProgrammaticFunctionName is the exact name of a method within its interface. @param nArgument the index of the argument (0-based). @returns the description of the specified argument. */ string getArgumentDescription( [in] string aProgrammaticFunctionName, [in] long nArgument ); //------------------------------------------------------------------------- /** returns the programmatic name of the category the function belongs to.

The category name is used to group similar functions together. The programmatic category name should always be in English, it is never shown to the user. It should be one of the following names if the function falls into the corresponding category.

Database
for functions that operate with data organized in tabular form like databases.
Date&Time
for functions that deal with date or time values.
Financial
for functions that solve financial problems.
Information
for functions that provide information about cells.
Logical
for functions that deal with logical expressions.
Mathematical
for mathematical functions.
Matrix
for matrix functions.
Statistical
for statistical functions.
Spreadsheet
for functions that deal with cell ranges.
Text
for functions that deal with text strings.
Add-In
for additional functions.
@param aProgrammaticFunctionName is the exact name of a method within its interface. @returns the category name the specified function belongs to. */ string getProgrammaticCategoryName( [in] string aProgrammaticFunctionName ); //------------------------------------------------------------------------- /** returns the user-visible name of the category the function belongs to.

This is used when category names are shown to the user.

@param aProgrammaticFunctionName is the exact name of a method within its interface. @returns the user-visible category name the specified function belongs to. */ string getDisplayCategoryName( [in] string aProgrammaticFunctionName ); }; //============================================================================= }; }; }; }; #endif