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