summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XFunctionAccess.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sheet/XFunctionAccess.idl')
-rw-r--r--offapi/com/sun/star/sheet/XFunctionAccess.idl117
1 files changed, 0 insertions, 117 deletions
diff --git a/offapi/com/sun/star/sheet/XFunctionAccess.idl b/offapi/com/sun/star/sheet/XFunctionAccess.idl
deleted file mode 100644
index 439af6086..000000000
--- a/offapi/com/sun/star/sheet/XFunctionAccess.idl
+++ /dev/null
@@ -1,117 +0,0 @@
-/*************************************************************************
- *
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * Copyright 2000, 2010 Oracle and/or its affiliates.
- *
- * OpenOffice.org - a multi-platform office productivity suite
- *
- * This file is part of OpenOffice.org.
- *
- * OpenOffice.org is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License version 3
- * only, as published by the Free Software Foundation.
- *
- * OpenOffice.org 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 version 3 for more details
- * (a copy is included in the LICENSE file that accompanied this code).
- *
- * You should have received a copy of the GNU Lesser General Public License
- * version 3 along with OpenOffice.org. If not, see
- * <http://www.openoffice.org/license.html>
- * for a copy of the LGPLv3 License.
- *
- ************************************************************************/
-
-#ifndef __com_sun_star_sheet_XFunctionAccess_idl__
-#define __com_sun_star_sheet_XFunctionAccess_idl__
-
-#include <com/sun/star/uno/XInterface.idl>
-#include <com/sun/star/container/NoSuchElementException.idl>
-#include <com/sun/star/lang/IllegalArgumentException.idl>
-
-//=============================================================================
-
-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
-