summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/FunctionAccess.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/sheet/FunctionAccess.idl77
1 files changed, 77 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/FunctionAccess.idl b/offapi/com/sun/star/sheet/FunctionAccess.idl
new file mode 100644
index 000000000..9b26c286e
--- /dev/null
+++ b/offapi/com/sun/star/sheet/FunctionAccess.idl
@@ -0,0 +1,77 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_sheet_FunctionAccess_idl__
+#define __com_sun_star_sheet_FunctionAccess_idl__
+
+#include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl>
+#include <com/sun/star/sheet/XFunctionAccess.idl>
+
+
+module com { module sun { module star { module sheet {
+
+
+/** allows generic access to all spreadsheet functions.
+ */
+published service FunctionAccess
+{
+
+ /** contributes properties to control the behavior of some functions
+ (i.e. NullDate, IgnoreCase, RegularExpressions).
+ */
+ service com::sun::star::sheet::SpreadsheetDocumentSettings;
+
+
+ /** provides calculating the result of a spreadsheet function.
+ */
+ interface com::sun::star::sheet::XFunctionAccess;
+
+
+ /** specifies whether the function call is performed as array function
+ call.
+
+ <p>If set to `TRUE`, the result of the function call will be
+ calculated similar to array formulas in a spreadsheet document. The
+ return value of the function call will usually be a sequence of
+ sequences containing the values of the resulting array. Example: If the
+ function ABS is called for a 3x2 cell range, the result will be a 3x2
+ array containing the absolute values of the numbers contained in the
+ specified cell range.</p>
+
+ <p>If set to `FALSE`, the result of the function call will be
+ calculated similar to simple cell formulas in a spreadsheet document.
+ The return value of the function call will usually be a single value.
+ Of course, some functions always return an array, for example the
+ MUNIT function.</p>
+
+ <p>For compatibility with older versions, the default value of this
+ property is `TRUE`.</p>
+
+ @since OOo 3.3
+ */
+ [optional, property] boolean IsArrayFunction;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */