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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_FunctionAccess_idl__
  29 #define __com_sun_star_sheet_FunctionAccess_idl__
  30
  31 #ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__
  32 #include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_sheet_XFunctionAccess_idl__
  36 #include <com/sun/star/sheet/XFunctionAccess.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** allows generic access to all spreadsheet functions.
  46  */
  47 published service FunctionAccess
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** contributes properties to control the behaviour of some functions
  52         (i.e. NullDate, IgnoreCase, RegularExpressions).
  53      */
  54     service com::sun::star::sheet::SpreadsheetDocumentSettings;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** provides calculating the result of a spreadsheet function.
  59      */
  60     interface com::sun::star::sheet::XFunctionAccess;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** specifies whether the function call is performed as array function
  65         call.
  66
  67         <p>If set to <TRUE/>, the result of the function call will be
  68         calculated similar to array formulas in a spreadsheet document. The
  69         return value of the function call will usually be a sequence of
  70         sequences containing the values of the resulting array. Example: If the
  71         function ABS is called for a 3x2 cell range, the result will be a 3x2
  72         array containing the absolute values of the numbers contained in the
  73         specified cell range.</p>
  74
  75         <p>If set to <FALSE/>, the result of the function call will be
  76         calculated similar to simple cell formulas in a spreadsheet document.
  77         The return value of the function call will usually be a single value.
  78         Of course, some functions always return an array, for example the
  79         MUNIT function.</p>
  80
  81         <p>For compatibility with older versions, the default value of this
  82         property is <TRUE/>.</p>
  83
  84         @since OOo 3.3
  85      */
  86     [optional, property] boolean IsArrayFunction;
  87
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif
  95