LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
AddIn Service Referencepublished

is the base for AddIn services that supply functions which can be called by other components. More...

import"AddIn.idl";

Inheritance diagram for AddIn:
XServiceName XAddIn XCompatibilityNames XInterface XLocalizable XInterface XInterface

Exported Interfaces

interface com::sun::star::lang::XServiceName
 contains a method that returns the service name of the add-in. More...
 
interface com::sun::star::sheet::XAddIn
 provides access to function descriptions and localized names and descriptions. More...
 
interface com::sun::star::sheet::XCompatibilityNames
 provides access to compatibility names for the functions. More...
 

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. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XAddIn
string getProgrammaticFuntionName ([in] string aDisplayName)
 returns the internal function name for an user-visible name. More...
 
string getDisplayFunctionName ([in] string aProgrammaticName)
 returns the user-visible function name for an internal name. More...
 
string getFunctionDescription ([in] string aProgrammaticName)
 returns the description of a function. More...
 
string getDisplayArgumentName ([in] string aProgrammaticFunctionName, [in] long nArgument)
 returns the user-visible name of the specified argument. More...
 
string getArgumentDescription ([in] string aProgrammaticFunctionName, [in] long nArgument)
 returns the description of the specified argument. More...
 
string getProgrammaticCategoryName ([in] string aProgrammaticFunctionName)
 returns the programmatic name of the category the function belongs to. More...
 
string getDisplayCategoryName ([in] string aProgrammaticFunctionName)
 returns the user-visible name of the category the function belongs to. More...
 
- Public Member Functions inherited from XLocalizable
void setLocale ([in] Locale eLocale)
 sets the locale to be used by this object. More...
 
Locale getLocale ()
 
- Protected Member Functions inherited from XCompatibilityNames
sequence< com::sun::star::sheet::LocalizedNamegetCompatibilityNames ([in] string aProgrammaticName)
 returns the compatibility names of the specified function. More...
 

Detailed Description

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:

long

for integer values.

double

for floating point values.

string

for text strings.

long[][]

for (two-dimensional) arrays of integer values.

double[][]

for (two-dimensional) arrays of floating point values.

string[][]

for (two-dimensional) arrays of text strings.

any[][]

for (two-dimensional) arrays of mixed contents. Each any will contain a double or a string, depending on the data.

any

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.

com::sun::star::table::XCellRange

for a com::sun::star::table::XCellRange interface to the source data.

com::sun::star::beans::XPropertySet

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.

any[]
for varying parameters. Only the last parameter of a function may have this type. It will be filled with the remaining arguments of the function call that were not used for the previous parameters. Each element of the sequence will be filled as in the case of any above.

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.

Developers Guide
Spreadsheets - Spreadsheet Add-Ins

Exported Interfaces

contains a method that returns the service name of the add-in.

provides access to function descriptions and localized names and descriptions.

provides access to compatibility names for the functions.


The documentation for this service was generated from the following file: