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