offapi/com/sun/star/sheet/XFunctionAccess.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_XFunctionAccess_idl__
  21 #define __com_sun_star_sheet_XFunctionAccess_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/container/NoSuchElementException.idl>
  25 #include <com/sun/star/lang/IllegalArgumentException.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** allows generic access to all spreadsheet functions.
  32
  33     @see com::sun::star::sheet::FunctionAccess
  34  */
  35 published interface XFunctionAccess: com::sun::star::uno::XInterface
  36 {
  37
  38     /** calls a function and returns the result of the call.
  39
  40         @param aName
  41         the (programmatic) name of the function.
  42
  43         @param aArguments
  44         the arguments for the function call.
  45         <p>Each element must be of one of the following types:</p>
  46
  47         <dl>
  48         <dt>`long` or `double`</dt>
  49         <dd>for a numeric value.</dd>
  50
  51         <dt>`string`</dt>
  52         <dd>for a textual value.</dd>
  53
  54         <dt>`long[][]` or `double[][]`</dt>
  55         <dd>for an array of numeric values.</dd>
  56
  57         <dt>`string[][]`</dt>
  58         <dd>for an array of textual values.</dd>
  59
  60         <dt>`any[][]`</dt>
  61         <dd>for a mixed array, where each element must be of `VOID`,
  62         `long`, `double` or `string`
  63         type.</dd>
  64
  65         <dt>com::sun::star::table::XCellRange</dt>
  66         <dd>for a SheetCellRange object that contains the
  67         data.</dd>
  68         </dl>
  69
  70         @returns
  71             the result of the function call.
  72
  73             <p>Possible types for the result are:</p>
  74
  75             <dl>
  76             <dt>`VOID`</dt>
  77             <dd>if no result is available.</dd>
  78
  79             <dt>`double`</dt>
  80             <dd>for a numeric result.</dd>
  81
  82             <dt>`string`</dt>
  83             <dd>for a textual result.</dd>
  84
  85             <dt>`any[][]`</dt>
  86             <dd>for an array result, containing `double` and
  87             `string` values.</dd>
  88             </dl>
  89
  90         @throws com::sun::star::container::NoSuchElementException
  91             if the named function does not exist.
  92
  93         @throws com::sun::star::lang::IllegalArgumentException
  94             if the function can not be called with these arguments.
  95      */
  96     any callFunction( [in] string aName, [in] sequence< any > aArguments )
  97             raises( com::sun::star::container::NoSuchElementException,
  98                     com::sun::star::lang::IllegalArgumentException );
  99 };
 100
 101
 102 }; }; }; };
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */