/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XCellRangeFormula.idl,v $
 * $Revision: 1.8 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XCellRangeFormula_idl__
#define __com_sun_star_sheet_XCellRangeFormula_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** allows to get and set cell contents (values, text or formulas)
    for a cell range.

    <p>The outer sequence represents the rows and the inner sequence
    the columns of the array.</p>

    @since OOo 1.1.2
 */

published interface XCellRangeFormula: com::sun::star::uno::XInterface
{
    /** gets an array from the contents of the cell range.

        <p>Each element of the result contains the same string that
        would be returned by
        <member scope="com::sun::star::table">XCell::getFormula()</member>
        for the corresponding cell.</p>
     */
    sequence< sequence< string > > getFormulaArray();

    /** fills the cell range with values from an array.

        <p>The size of the array must be the same as the size of the cell
        range. Each element of the array is interpreted the same way as
        the argument to a
        <member scope="com::sun::star::table">XCell::setFormula()</member>
        call for the corresponding cell.</p>

        @throws <type scope="com::sun::star::uno">RuntimeException</type>
            If the size of the array is different from the current size.
     */
    void setFormulaArray( [in] sequence< sequence< string > > aArray );
};

//=============================================================================
}; }; }; };

#endif