/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XFunctionAccess.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 05:10:13 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/

#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.

	@see com::sun::star::sheet::FunctionAccess
 */
published 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>long[][]</atom> or <atom>double[][]</atom></dt>
		<dd>for an array of numeric values.</dd>

		<dt><atom>string[][]</atom></dt>
		<dd>for an array of textual values.</dd>

		<dt><atom>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.</dd>
		</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>any[][]</atom></dt>
			<dd>for an array result, containing <atom>double</atom> and
			<atom>string</atom> values.</dd>
			</dl>

		@throws <type scope="com::sun::star::container">NoSuchElementException</type>
			if the named function does not exist.

		@throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
			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

