offapi/com/sun/star/table/XCell.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: XCell.idl,v $
  10  * $Revision: 1.10 $
  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
  31 #ifndef __com_sun_star_table_XCell_idl__
  32 #define __com_sun_star_table_XCell_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellContentType_idl__
  39 #include <com/sun/star/table/CellContentType.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module table {
  45
  46 //=============================================================================
  47
  48 /** provides methods to access the contents of a cell in a table.
  49
  50     @see com::sun::star::table::Cell
  51  */
  52 published interface XCell: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** returns the formula string of a cell.
  57
  58         <p>Even if the cell does not contain a formula, an assignment of
  59         this attribute's value to another cell's formula attribute would
  60         create the same cell content. This is because this attribute contains
  61         the original text value of a string cell. The value of a
  62         <em>value cell</em> will be formatted using the number format's
  63         default format or the formula string, including "=", of a formula
  64         cell.</p>
  65      */
  66     string getFormula();
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** sets a formula into the cell.
  71
  72         <p>When assigned, the string will be interpreted and a value, text
  73         or formula cell is created, depending on the text and the number
  74         format.</p>
  75      */
  76     void setFormula( [in] string aFormula );
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** returns the floating point value of the cell.
  81
  82         <p>For a <em>value cell</em> the value is returnd, for a
  83         <em>string cell</em> zero is returned and for a <em>formula cell</em>
  84         the result value of a formula is returned.</p>
  85      */
  86     double getValue();
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** sets a floating point value into the cell.
  91
  92         <p>After a call to this method the type of the cell is
  93         <member>CellContentType::VALUE</member>.</p>
  94      */
  95     void setValue( [in] double nValue );
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** returns the type of the cell.
 100      */
 101     com::sun::star::table::CellContentType getType();
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** returns the error value of the cell.
 106
 107         <P>If the cell does not contain a formula, the error is always
 108         zero.</p>
 109      */
 110     long getError();
 111
 112 };
 113
 114 //=============================================================================
 115
 116 }; }; }; };
 117
 118 #endif
 119