1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_FunctionAccess_idl__
25#define __com_sun_star_sheet_FunctionAccess_idl__
26
27#ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__
28#include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_XFunctionAccess_idl__
32#include <com/sun/star/sheet/XFunctionAccess.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** allows generic access to all spreadsheet functions.
42 */
43published service FunctionAccess
44{
45	//-------------------------------------------------------------------------
46
47	/** contributes properties to control the behaviour of some functions
48		(i.e. NullDate, IgnoreCase, RegularExpressions).
49	 */
50	service com::sun::star::sheet::SpreadsheetDocumentSettings;
51
52	//-------------------------------------------------------------------------
53
54	/** provides calculating the result of a spreadsheet function.
55	 */
56	interface com::sun::star::sheet::XFunctionAccess;
57
58	//-------------------------------------------------------------------------
59
60	/** specifies whether the function call is performed as array function
61	    call.
62
63        <p>If set to <TRUE/>, the result of the function call will be
64        calculated similar to array formulas in a spreadsheet document. The
65        return value of the function call will usually be a sequence of
66        sequences containing the values of the resulting array. Example: If the
67        function ABS is called for a 3x2 cell range, the result will be a 3x2
68        array containing the absolute values of the numbers contained in the
69        specified cell range.</p>
70
71        <p>If set to <FALSE/>, the result of the function call will be
72        calculated similar to simple cell formulas in a spreadsheet document.
73        The return value of the function call will usually be a single value.
74        Of course, some functions always return an array, for example the
75        MUNIT function.</p>
76
77        <p>For compatibility with older versions, the default value of this
78        property is <TRUE/>.</p>
79
80	    @since OOo 3.3
81	 */
82	[optional, property] boolean IsArrayFunction;
83
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91
92