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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XArrayFormulaRange.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_XArrayFormulaRange_idl__
  32 #define __com_sun_star_sheet_XArrayFormulaRange_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** provides handling of array formulas in a cell range.
  45  */
  46 published interface XArrayFormulaRange: com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** returns the array formula of the range or an empty string, if the
  51         range does not contain an array formula.
  52      */
  53     string getArrayFormula();
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** applies the array formula to the entire cell range.
  58
  59         @param aFormula
  60             the formula that will be applied as array formula. Passing an
  61             empty string erases an existing array formula.
  62      */
  63     void setArrayFormula( [in] string aFormula );
  64
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif
  72