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