LibreOffice
LibreOffice 25.8 SDK API Reference
|
is the base for AddIn services that supply functions which can be called by other components. More...
import "AddIn.idl";
Exported Interfaces | |
interface | com::sun::star::lang::XServiceName |
contains a method that returns the service name of the add-in. | |
interface | com::sun::star::sheet::XAddIn |
provides access to function descriptions and localized names and descriptions. | |
interface | com::sun::star::sheet::XCompatibilityNames |
provides access to compatibility names for the functions. |
Additional Inherited Members | |
Public Member Functions inherited from XServiceName | |
string | getServiceName () |
Public Member Functions inherited from XInterface | |
any | queryInterface ([in] type aType) |
queries for a new interface to an existing UNO object. | |
void | acquire () |
increases the reference counter by one. | |
void | release () |
decreases the reference counter by one. | |
Public Member Functions inherited from XAddIn | |
string | getProgrammaticFuntionName ([in] string aDisplayName) |
returns the internal function name for an user-visible name. | |
string | getDisplayFunctionName ([in] string aProgrammaticName) |
returns the user-visible function name for an internal name. | |
string | getFunctionDescription ([in] string aProgrammaticName) |
returns the description of a function. | |
string | getDisplayArgumentName ([in] string aProgrammaticFunctionName, [in] long nArgument) |
returns the user-visible name of the specified argument. | |
string | getArgumentDescription ([in] string aProgrammaticFunctionName, [in] long nArgument) |
returns the description of the specified argument. | |
string | getProgrammaticCategoryName ([in] string aProgrammaticFunctionName) |
returns the programmatic name of the category the function belongs to. | |
string | getDisplayCategoryName ([in] string aProgrammaticFunctionName) |
returns the user-visible name of the category the function belongs to. | |
Public Member Functions inherited from XLocalizable | |
void | setLocale ([in] Locale eLocale) |
sets the locale to be used by this object. | |
Locale | getLocale () |
Protected Member Functions inherited from XCompatibilityNames | |
sequence< com::sun::star::sheet::LocalizedName > | getCompatibilityNames ([in] string aProgrammaticName) |
returns the compatibility names of the specified function. |
is the base for AddIn services that supply functions which can be called by other components.
Any AddIn implementation must implement a service describing its specific set of functions. That service must contain the AddIn service, and the functions that are implemented, in one or more interfaces. The com::sun::star::lang::XServiceName interface must describe that service, and the XAddIn interface must describe the individual functions.
Each AddIn function can take parameters of the following types:
for integer values.
for floating point values.
for text strings.
for (two-dimensional) arrays of integer values.
for (two-dimensional) arrays of floating point values.
for (two-dimensional) arrays of text strings.
for (two-dimensional) arrays of mixed contents. Each any will contain a double or a string, depending on the data.
Depending on the data, a double, a string, or an any[][] will be passed. If no argument is specified in the function call, VOID will be passed. This allows for optional parameters.
for a com::sun::star::table::XCellRange interface to the source data.
for a com::sun::star::beans::XPropertySet interface to the SpreadsheetDocument making the function call. Only one parameter of this type is allowed in each function. It can be used to query document settings like SpreadsheetDocumentSettings::NullDate.
Each AddIn function must have one of the following return types:
The sequences must contain arrays as described above for the parameter types. An XVolatileResult return value must contain an object implementing the VolatileResult service, that contains a volatile result. Subsequent calls with the same parameters must return the same object. An any return value can contain any of the other types.
interface com::sun::star::lang::XServiceName |
contains a method that returns the service name of the add-in.
interface com::sun::star::sheet::XAddIn |
provides access to function descriptions and localized names and descriptions.
|
optional |
provides access to compatibility names for the functions.