offapi/com/sun/star/sheet/XArrayFormulaRange.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_XArrayFormulaRange_idl__
  21 #define __com_sun_star_sheet_XArrayFormulaRange_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** provides handling of array formulas in a cell range.
  30  */
  31 published interface XArrayFormulaRange: com::sun::star::uno::XInterface
  32 {
  33
  34     /** returns the array formula of the range or an empty string, if the
  35         range does not contain an array formula.
  36      */
  37     string getArrayFormula();
  38
  39
  40     /** applies the array formula to the entire cell range.
  41
  42         @param aFormula
  43             the formula that will be applied as array formula. Passing an
  44             empty string erases an existing array formula.
  45      */
  46     void setArrayFormula( [in] string aFormula );
  47
  48 };
  49
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */