192 lines
6.1 KiB
Text
192 lines
6.1 KiB
Text
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* 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 .
|
|
*/
|
|
|
|
|
|
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.
|
|
|
|
<p>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.</p>
|
|
|
|
<p>Attention: The method name contains a spelling error. Due to
|
|
compatibility reasons the name cannot be changed.</p>
|
|
|
|
@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.
|
|
|
|
<p>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.</p>
|
|
|
|
@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.
|
|
|
|
<p>The description is shown to the user when selecting functions.
|
|
It may be translated to the current language of the AddIn.</p>
|
|
|
|
@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.
|
|
|
|
<p>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.</p>
|
|
|
|
@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.
|
|
|
|
<p>The argument description is shown to the user when prompting
|
|
for arguments. It may be translated to the current language of
|
|
the AddIn.</p>
|
|
|
|
@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.
|
|
|
|
<p>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.</p>
|
|
|
|
<dl>
|
|
<dt>Database</dt>
|
|
<dd>for functions that operate with data organized in tabular form
|
|
like databases.</dd>
|
|
|
|
<dt>Date&Time</dt>
|
|
<dd>for functions that deal with date or time values.</dd>
|
|
|
|
<dt>Financial</dt>
|
|
<dd>for functions that solve financial problems.</dd>
|
|
|
|
<dt>Information</dt>
|
|
<dd>for functions that provide information about cells.</dd>
|
|
|
|
<dt>Logical</dt>
|
|
<dd>for functions that deal with logical expressions.</dd>
|
|
|
|
<dt>Mathematical</dt>
|
|
<dd>for mathematical functions.</dd>
|
|
|
|
<dt>Matrix</dt>
|
|
<dd>for matrix functions.</dd>
|
|
|
|
<dt>Statistical</dt>
|
|
<dd>for statistical functions.</dd>
|
|
|
|
<dt>Spreadsheet</dt>
|
|
<dd>for functions that deal with cell ranges.</dd>
|
|
|
|
<dt>Text</dt>
|
|
<dd>for functions that deal with text strings.</dd>
|
|
|
|
<dt>Add-In</dt>
|
|
<dd>for additional functions.</dd>
|
|
</dl>
|
|
|
|
@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.
|
|
|
|
<p>This is used when category names are shown to the user.</p>
|
|
|
|
@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 );
|
|
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|