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