1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_XFunctionAccess_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_sheet_XFunctionAccess_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_NoSuchElementException_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/container/NoSuchElementException.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sheet { 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski/** allows generic access to all spreadsheet functions. 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski @see com::sun::star::sheet::FunctionAccess 48*b1cdbd2cSJim Jagielski */ 49*b1cdbd2cSJim Jagielskipublished interface XFunctionAccess: com::sun::star::uno::XInterface 50*b1cdbd2cSJim Jagielski{ 51*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski /** calls a function and returns the result of the call. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski @param aName 56*b1cdbd2cSJim Jagielski the (programmatic) name of the function. 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @param aArguments 59*b1cdbd2cSJim Jagielski the arguments for the function call. 60*b1cdbd2cSJim Jagielski <p>Each element must be of one of the following types:</p> 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski <dl> 63*b1cdbd2cSJim Jagielski <dt><atom>long</atom> or <atom>double</atom></dt> 64*b1cdbd2cSJim Jagielski <dd>for a numeric value.</dd> 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski <dt><atom>string</atom></dt> 67*b1cdbd2cSJim Jagielski <dd>for a textual value.</dd> 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski <dt><atom>long[][]</atom> or <atom>double[][]</atom></dt> 70*b1cdbd2cSJim Jagielski <dd>for an array of numeric values.</dd> 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski <dt><atom>string[][]</atom></dt> 73*b1cdbd2cSJim Jagielski <dd>for an array of textual values.</dd> 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski <dt><atom>any[][]</atom></dt> 76*b1cdbd2cSJim Jagielski <dd>for a mixed array, where each element must be of <void/>, 77*b1cdbd2cSJim Jagielski <atom>long</atom>, <atom>double</atom> or <atom>string</atom> 78*b1cdbd2cSJim Jagielski type.</dd> 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski <dt><type scope="com::sun::star::table">XCellRange</type></dt> 81*b1cdbd2cSJim Jagielski <dd>for a <type>SheetCellRange</type> object that contains the 82*b1cdbd2cSJim Jagielski data.</dd> 83*b1cdbd2cSJim Jagielski </dl> 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski @returns 86*b1cdbd2cSJim Jagielski the result of the function call. 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski <p>Possible types for the result are:</p> 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski <dl> 91*b1cdbd2cSJim Jagielski <dt><void/></dt> 92*b1cdbd2cSJim Jagielski <dd>if no result is available.</dd> 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski <dt><atom>double</atom></dt> 95*b1cdbd2cSJim Jagielski <dd>for a numeric result.</dd> 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski <dt><atom>string</atom></dt> 98*b1cdbd2cSJim Jagielski <dd>for a textual result.</dd> 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski <dt><atom>any[][]</atom></dt> 101*b1cdbd2cSJim Jagielski <dd>for an array result, containing <atom>double</atom> and 102*b1cdbd2cSJim Jagielski <atom>string</atom> values.</dd> 103*b1cdbd2cSJim Jagielski </dl> 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski @throws <type scope="com::sun::star::container">NoSuchElementException</type> 106*b1cdbd2cSJim Jagielski if the named function does not exist. 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> 109*b1cdbd2cSJim Jagielski if the function can not be called with these arguments. 110*b1cdbd2cSJim Jagielski */ 111*b1cdbd2cSJim Jagielski any callFunction( [in] string aName, [in] sequence< any > aArguments ) 112*b1cdbd2cSJim Jagielski raises( com::sun::star::container::NoSuchElementException, 113*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException ); 114*b1cdbd2cSJim Jagielski}; 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski//============================================================================= 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski}; }; }; }; 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski#endif 121*b1cdbd2cSJim Jagielski 122