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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFunctionAccess.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_XFunctionAccess_idl__
  32 #define __com_sun_star_sheet_XFunctionAccess_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  39 #include <com/sun/star/container/NoSuchElementException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  43 #include <com/sun/star/lang/IllegalArgumentException.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module sheet {
  49
  50 //=============================================================================
  51
  52 /** allows generic access to all spreadsheet functions.
  53
  54     @see com::sun::star::sheet::FunctionAccess
  55  */
  56 published interface XFunctionAccess: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** calls a function and returns the result of the call.
  61
  62         @param aName
  63         the (programmatic) name of the function.
  64
  65         @param aArguments
  66         the arguments for the function call.
  67         <p>Each element must be of one of the following types:</p>
  68
  69         <dl>
  70         <dt><atom>long</atom> or <atom>double</atom></dt>
  71         <dd>for a numeric value.</dd>
  72
  73         <dt><atom>string</atom></dt>
  74         <dd>for a textual value.</dd>
  75
  76         <dt><atom>long[][]</atom> or <atom>double[][]</atom></dt>
  77         <dd>for an array of numeric values.</dd>
  78
  79         <dt><atom>string[][]</atom></dt>
  80         <dd>for an array of textual values.</dd>
  81
  82         <dt><atom>any[][]</atom></dt>
  83         <dd>for a mixed array, where each element must be of <void/>,
  84         <atom>long</atom>, <atom>double</atom> or <atom>string</atom>
  85         type.</dd>
  86
  87         <dt><type scope="com::sun::star::table">XCellRange</type></dt>
  88         <dd>for a <type>SheetCellRange</type> object that contains the
  89         data.</dd>
  90         </dl>
  91
  92         @returns
  93             the result of the function call.
  94
  95             <p>Possible types for the result are:</p>
  96
  97             <dl>
  98             <dt><void/></dt>
  99             <dd>if no result is available.</dd>
 100
 101             <dt><atom>double</atom></dt>
 102             <dd>for a numeric result.</dd>
 103
 104             <dt><atom>string</atom></dt>
 105             <dd>for a textual result.</dd>
 106
 107             <dt><atom>any[][]</atom></dt>
 108             <dd>for an array result, containing <atom>double</atom> and
 109             <atom>string</atom> values.</dd>
 110             </dl>
 111
 112         @throws <type scope="com::sun::star::container">NoSuchElementException</type>
 113             if the named function does not exist.
 114
 115         @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
 116             if the function can not be called with these arguments.
 117      */
 118     any callFunction( [in] string aName, [in] sequence< any > aArguments )
 119             raises( com::sun::star::container::NoSuchElementException,
 120                     com::sun::star::lang::IllegalArgumentException );
 121 };
 122
 123 //=============================================================================
 124
 125 }; }; }; };
 126
 127 #endif
 128