offapi/com/sun/star/sheet/AddIn.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_AddIn_idl__
  21 #define __com_sun_star_sheet_AddIn_idl__
  22
  23 #include <com/sun/star/lang/XServiceName.idl>
  24 #include <com/sun/star/sheet/XAddIn.idl>
  25 #include <com/sun/star/sheet/XCompatibilityNames.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** is the base for AddIn services that supply functions which can be called
  32     by other components.
  33
  34     <p>Any AddIn implementation must implement a service describing its
  35     specific set of functions.
  36     That service must contain the AddIn service, and the
  37     functions that are implemented, in one or more interfaces.
  38     The com::sun::star::lang::XServiceName interface
  39     must describe that service, and the XAddIn interface
  40     must describe the individual functions.</p>
  41
  42     <p>Each AddIn function can take parameters of the following types:</p>
  43
  44     <dl>
  45     <dt>`long`</dt>
  46     <dd>for integer values.</dd>
  47
  48     <dt>`double`</dt>
  49     <dd>for floating point values.</dd>
  50
  51     <dt>`string`</dt>
  52     <dd>for text strings.</dd>
  53
  54     <dt>`long[][]`</dt>
  55     <dd>for (two-dimensional) arrays of integer values.</dd>
  56
  57     <dt>`double[][]`</dt>
  58     <dd>for (two-dimensional) arrays of floating point values.</dd>
  59
  60     <dt>`string[][]`</dt>
  61     <dd>for (two-dimensional) arrays of text strings.</dd>
  62
  63     <dt>`any[][]`</dt>
  64     <dd>for (two-dimensional) arrays of mixed contents. Each `any`
  65     will contain a `double` or a `string`, depending on
  66     the data.</dd>
  67
  68     <dt>`any`</dt>
  69     <dd>Depending on the data, a `double`, a `string`,
  70     or an `any[][]` will be passed. If no argument is specified in
  71     the function call, `VOID` will be passed. This allows for optional
  72     parameters.</dd>
  73
  74     <dt>com::sun::star::table::XCellRange</dt>
  75     <dd>for a com::sun::star::table::XCellRange interface
  76     to the source data.</dd>
  77
  78     <dt>com::sun::star::beans::XPropertySet</dt>
  79     <dd>for a com::sun::star::beans::XPropertySet
  80     interface to the SpreadsheetDocument making the function
  81     call. Only one parameter of this type is allowed in each function. It
  82     can be used to query document settings like
  83     SpreadsheetDocumentSettings::NullDate.</dd>
  84
  85     <dt>`any[]`</dt>
  86     <dd>for varying parameters. Only the last parameter of a function may
  87     have this type. It will be filled with the remaining arguments of the
  88     function call that were not used for the previous parameters. Each
  89     element of the sequence will be filled as in the case of `any`
  90     above.</dd>
  91     </dl>
  92
  93     <p>Each AddIn function must have one of the following return types:</p>
  94
  95     <ul>
  96     <li>`long`</li>
  97     <li>`double`</li>
  98     <li>`string`</li>
  99     <li>`long[][]`</li>
 100     <li>`double[][]`</li>
 101     <li>`string[][]`</li>
 102     <li>`any[][]`</li>
 103     <li>XVolatileResult</li>
 104     <li>`any`</li>
 105     </ul>
 106
 107     <p>The sequences must contain arrays as described above for the
 108     parameter types.
 109     An XVolatileResult return value must contain an object
 110     implementing the VolatileResult service, that contains
 111     a volatile result. Subsequent calls with the same parameters must
 112     return the same object.
 113     An `any` return value can contain any of the other types.</p>
 114  */
 115 published service AddIn
 116 {
 117
 118     /** contains a method that returns the service name of the add-in.
 119      */
 120     interface com::sun::star::lang::XServiceName;
 121
 122
 123     /** provides access to function descriptions and localized names
 124         and descriptions.
 125       */
 126     interface com::sun::star::sheet::XAddIn;
 127
 128
 129     /** provides access to compatibility names for the functions.
 130      */
 131     [optional] interface com::sun::star::sheet::XCompatibilityNames;
 132 };
 133
 134
 135 }; }; }; };
 136
 137 #endif
 138
 139 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */