offapi/com/sun/star/sheet/FunctionAccess.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_FunctionAccess_idl__
  21 #define __com_sun_star_sheet_FunctionAccess_idl__
  22
  23 #include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl>
  24 #include <com/sun/star/sheet/XFunctionAccess.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** allows generic access to all spreadsheet functions.
  31  */
  32 published service FunctionAccess
  33 {
  34
  35     /** contributes properties to control the behavior of some functions
  36         (i.e. NullDate, IgnoreCase, RegularExpressions).
  37      */
  38     service com::sun::star::sheet::SpreadsheetDocumentSettings;
  39
  40
  41     /** provides calculating the result of a spreadsheet function.
  42      */
  43     interface com::sun::star::sheet::XFunctionAccess;
  44
  45
  46     /** specifies whether the function call is performed as array function
  47         call.
  48
  49         <p>If set to `TRUE`, the result of the function call will be
  50         calculated similar to array formulas in a spreadsheet document. The
  51         return value of the function call will usually be a sequence of
  52         sequences containing the values of the resulting array. Example: If the
  53         function ABS is called for a 3x2 cell range, the result will be a 3x2
  54         array containing the absolute values of the numbers contained in the
  55         specified cell range.</p>
  56
  57         <p>If set to `FALSE`, the result of the function call will be
  58         calculated similar to simple cell formulas in a spreadsheet document.
  59         The return value of the function call will usually be a single value.
  60         Of course, some functions always return an array, for example the
  61         MUNIT function.</p>
  62
  63         <p>For compatibility with older versions, the default value of this
  64         property is `TRUE`.</p>
  65
  66         @since OOo 3.3
  67      */
  68     [optional, property] boolean IsArrayFunction;
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */