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