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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** is the base for AddIn services that supply functions which can be called
  25     by other components.
  26
  27     <p>Any AddIn implementation must implement a service describing its
  28     specific set of functions.
  29     That service must contain the AddIn service, and the
  30     functions that are implemented, in one or more interfaces.
  31     The com::sun::star::lang::XServiceName interface
  32     must describe that service, and the XAddIn interface
  33     must describe the individual functions.</p>
  34
  35     <p>Each AddIn function can take parameters of the following types:</p>
  36
  37     <dl>
  38     <dt>`long`</dt>
  39     <dd>for integer values.</dd>
  40
  41     <dt>`double`</dt>
  42     <dd>for floating point values.</dd>
  43
  44     <dt>`string`</dt>
  45     <dd>for text strings.</dd>
  46
  47     <dt>`long[][]`</dt>
  48     <dd>for (two-dimensional) arrays of integer values.</dd>
  49
  50     <dt>`double[][]`</dt>
  51     <dd>for (two-dimensional) arrays of floating point values.</dd>
  52
  53     <dt>`string[][]`</dt>
  54     <dd>for (two-dimensional) arrays of text strings.</dd>
  55
  56     <dt>`any[][]`</dt>
  57     <dd>for (two-dimensional) arrays of mixed contents. Each `any`
  58     will contain a `double` or a `string`, depending on
  59     the data.</dd>
  60
  61     <dt>`any`</dt>
  62     <dd>Depending on the data, a `double`, a `string`,
  63     or an `any[][]` will be passed. If no argument is specified in
  64     the function call, `VOID` will be passed. This allows for optional
  65     parameters.</dd>
  66
  67     <dt>com::sun::star::table::XCellRange</dt>
  68     <dd>for a com::sun::star::table::XCellRange interface
  69     to the source data.</dd>
  70
  71     <dt>com::sun::star::beans::XPropertySet</dt>
  72     <dd>for a com::sun::star::beans::XPropertySet
  73     interface to the SpreadsheetDocument making the function
  74     call. Only one parameter of this type is allowed in each function. It
  75     can be used to query document settings like
  76     SpreadsheetDocumentSettings::NullDate.</dd>
  77
  78     <dt>`any[]`</dt>
  79     <dd>for varying parameters. Only the last parameter of a function may
  80     have this type. It will be filled with the remaining arguments of the
  81     function call that were not used for the previous parameters. Each
  82     element of the sequence will be filled as in the case of `any`
  83     above.</dd>
  84     </dl>
  85
  86     <p>Each AddIn function must have one of the following return types:</p>
  87
  88     <ul>
  89     <li>`long`</li>
  90     <li>`double`</li>
  91     <li>`string`</li>
  92     <li>`long[][]`</li>
  93     <li>`double[][]`</li>
  94     <li>`string[][]`</li>
  95     <li>`any[][]`</li>
  96     <li>XVolatileResult</li>
  97     <li>`any`</li>
  98     </ul>
  99
 100     <p>The sequences must contain arrays as described above for the
 101     parameter types.
 102     An XVolatileResult return value must contain an object
 103     implementing the VolatileResult service, that contains
 104     a volatile result. Subsequent calls with the same parameters must
 105     return the same object.
 106     An `any` return value can contain any of the other types.</p>
 107  */
 108 published service AddIn
 109 {
 110
 111     /** contains a method that returns the service name of the add-in.
 112      */
 113     interface com::sun::star::lang::XServiceName;
 114
 115
 116     /** provides access to function descriptions and localized names
 117         and descriptions.
 118       */
 119     interface com::sun::star::sheet::XAddIn;
 120
 121
 122     /** provides access to compatibility names for the functions.
 123      */
 124     [optional] interface com::sun::star::sheet::XCompatibilityNames;
 125 };
 126
 127
 128 }; }; }; };
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */