offapi/com/sun/star/sheet/XCellRangeData.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 #ifndef __com_sun_star_sheet_XCellRangeData_idl__
  28 #define __com_sun_star_sheet_XCellRangeData_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 //=============================================================================
  35 module com {  module sun {  module star {  module sheet {
  36
  37 //=============================================================================
  38
  39 /** allows to get and set an array of data from a cell range.
  40     <p>The outer sequence represents the rows and the inner sequence
  41     the columns of the array.</p>
  42  */
  43
  44 published interface XCellRangeData: com::sun::star::uno::XInterface
  45 {
  46     /** gets an array from the contents of the cell range.
  47
  48         <p>Each element of the result contains a <atom>double</atom>
  49         or a <atom>string</atom>.</p>
  50      */
  51     sequence< sequence< any > > getDataArray();
  52
  53     /** fills the cell range with values from an array.
  54
  55         <p>The size of the array must be the same as the size of the cell
  56         range. Each element of the array must contain a <atom>double</atom>
  57         or a <atom>string</atom>.</p>
  58
  59         @throws <type scope="com::sun::star::uno">RuntimeException</type>
  60             If the size of the array is different from the current size.
  61      */
  62     void setDataArray( [in] sequence< sequence< any > > aArray );
  63 };
  64
  65 //=============================================================================
  66 }; }; }; };
  67
  68 #endif
  69