diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/XFunctionAccess.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/XFunctionAccess.idl | 149 |
1 files changed, 149 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XFunctionAccess.idl b/offapi/com/sun/star/sheet/XFunctionAccess.idl new file mode 100644 index 000000000000..a7862ef42380 --- /dev/null +++ b/offapi/com/sun/star/sheet/XFunctionAccess.idl @@ -0,0 +1,149 @@ +/************************************************************************* + * + * $RCSfile: XFunctionAccess.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:22:04 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sheet_XFunctionAccess_idl__ +#define __com_sun_star_sheet_XFunctionAccess_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module sheet { + +//============================================================================= + +/** allows generic access to all spreadsheet functions. + */ +[ uik(64D09001-953F-11d4-9FBA0050-04D75D79), ident( "XFunctionAccess", 1.0 ) ] +interface XFunctionAccess: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** calls a function and returns the result of the call. + + @param aName + the (programmatic) name of the function. + + @param aArguments + the arguments for the function call. + <p>Each element must be of one of the following types:</p> + <dl> + <dt><atom>long</atom> or <atom>double</atom></dt> + <dd>for a numeric value.</dd> + <dt><atom>string</atom></dt> + <dd>for a textual value.</dd> + <dt><atom dim="[][]">long</atom> or + <atom dim="[][]">double</atom></dt> + <dd>for an array of numeric values.</dd> + <dt><atom dim="[][]">string</atom></dt> + <dd>for an array of textual values.</dd> + <dt><atom dim="[][]">any</atom></dt> + <dd>for a mixed array, where each element must be of <void/>, + <atom>long</atom>, <atom>double</atom> or + <atom>string</atom> type.</dd> + <dt><type scope="com::sun::star::table">XCellRange</type></dt> + <dd>for a <type>SheetCellRange</type> object + that contains the data. + </dl> + + @returns + the result of the function call. + <p>Possible types for the result are:</p> + <dl> + <dt><void/></dt> + <dd>if no result is available.</dd> + <dt><atom>double</atom></dt> + <dd>for a numeric result.</dd> + <dt><atom>string</atom></dt> + <dd>for a textual result.</dd> + <dt><atom dim="[][]">any</atom></dt> + <dd>for an array result, containing <atom>double</atom> and + <atom>string</atom> values.</dd> + </dl> + + @throws NoSuchElementException + if the named function does not exist. + + @throws IllegalArgumentException + if the function can not be called with these arguments. + */ + any callFunction( [in] string aName, [in] sequence<any> aArguments ) + raises( com::sun::star::container::NoSuchElementException, + com::sun::star::lang::IllegalArgumentException ); +}; + +//============================================================================= + +}; }; }; }; + + +#endif + + |