/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XCell.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:51:05 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_table_XCell_idl__
#define __com_sun_star_table_XCell_idl__

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

#ifndef __com_sun_star_table_CellContentType_idl__
#include <com/sun/star/table/CellContentType.idl>
#endif

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

module com {  module sun {  module star {  module table {

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

/** provides methods to access the contents of a cell in a table.

    @see com::sun::star::table::Cell
 */
published interface XCell: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the formula string of a cell.

        <p>Even if the cell does not contain a formula, an assignment of
        this attribute's value to another cell's formula attribute would
        create the same cell content. This is because this attribute contains
        the original text value of a string cell. The value of a
        <em>value cell</em> will be formatted using the number format's
        default format or the formula string, including "=", of a formula
        cell.</p>
     */
    string getFormula();

    //-------------------------------------------------------------------------

    /** sets a formula into the cell.

        <p>When assigned, the string will be interpreted and a value, text
        or formula cell is created, depending on the text and the number
        format.</p>
     */
    void setFormula( [in] string aFormula );

    //-------------------------------------------------------------------------

    /** returns the floating point value of the cell.

        <p>For a <em>value cell</em> the value is returnd, for a
        <em>string cell</em> zero is returned and for a <em>formula cell</em>
        the result value of a formula is returned.</p>
     */
    double getValue();

    //-------------------------------------------------------------------------

    /** sets a floating point value into the cell.

        <p>After a call to this method the type of the cell is
        <member>CellContentType::VALUE</member>.</p>
     */
    void setValue( [in] double nValue );

    //-------------------------------------------------------------------------

    /** returns the type of the cell.
     */
    com::sun::star::table::CellContentType getType();

    //-------------------------------------------------------------------------

    /** returns the error value of the cell.

        <P>If the cell does not contain a formula, the error is always
        zero.</p>
     */
    long getError();

};

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

}; }; }; };

#endif

