offapi/com/sun/star/sheet/XCellRangeFormula.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_XCellRangeFormula_idl__
  29 #define __com_sun_star_sheet_XCellRangeFormula_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module sheet {
  38
  39 //=============================================================================
  40
  41 /** allows to get and set cell contents (values, text or formulas)
  42     for a cell range.
  43
  44     <p>The outer sequence represents the rows and the inner sequence
  45     the columns of the array.</p>
  46
  47     @since OOo 1.1.2
  48  */
  49
  50 published interface XCellRangeFormula: com::sun::star::uno::XInterface
  51 {
  52     /** gets an array from the contents of the cell range.
  53
  54         <p>Each element of the result contains the same string that
  55         would be returned by
  56         <member scope="com::sun::star::table">XCell::getFormula()</member>
  57         for the corresponding cell.</p>
  58      */
  59     sequence< sequence< string > > getFormulaArray();
  60
  61     /** fills the cell range with values from an array.
  62
  63         <p>The size of the array must be the same as the size of the cell
  64         range. Each element of the array is interpreted the same way as
  65         the argument to a
  66         <member scope="com::sun::star::table">XCell::setFormula()</member>
  67         call for the corresponding cell.</p>
  68
  69         @throws <type scope="com::sun::star::uno">RuntimeException</type>
  70             If the size of the array is different from the current size.
  71      */
  72     void setFormulaArray( [in] sequence< sequence< string > > aArray );
  73 };
  74
  75 //=============================================================================
  76 }; }; }; };
  77
  78 #endif
  79