diff options
Diffstat (limited to 'offapi/com/sun/star/table/XCell.idl')
-rw-r--r-- | offapi/com/sun/star/table/XCell.idl | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/offapi/com/sun/star/table/XCell.idl b/offapi/com/sun/star/table/XCell.idl new file mode 100644 index 000000000000..66048977fab0 --- /dev/null +++ b/offapi/com/sun/star/table/XCell.idl @@ -0,0 +1,189 @@ +/************************************************************************* + * + * $RCSfile: XCell.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:22:17 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 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 + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#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 { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::table::XCell +/** represents a cell in a table.@see service com::sun::star::table::Cell + */ +[ uik(E2281100-33D6-11D1-AABE00A0-249D5590), ident( "XCell", 1.0 ) ] +interface XCell: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR XCell::getFormula + + // DocMerge from xml: method com::sun::star::table::XCell::getFormula + /** returns the formula 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> + */ + [const] string getFormula(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::table::XCell::setFormula + /** 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 ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::table::XCell::getValue + /** 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> + */ + [const] double getValue(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::table::XCell::setValue + /** sets a floating point value into the cell. + + + + <p>After a call to this method the type of the cell is + <const>CellContentType::VALUE</const>.</p> + */ + void setValue( [in] double nValue ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::table::XCell::getType + /** returns the type of the cell. + */ + [const] com::sun::star::table::CellContentType getType(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::table::XCell::getError + /** @returns + the error value of the cell. + + <P>If the cell does not contain a formula, the error + is always zero. + */ + [const] long getError(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.2 2000/10/09 14:25:01 mi + #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) + + Revision 1.1.1.1 2000/09/18 23:35:55 hjs + initial import + + Revision 1.5 2000/09/11 11:52:58 mi + documentation merged from XML + + Revision 1.3 2000/03/24 13:19:37 nn + #74032# documentation added + + Revision 1.2 2000/02/07 11:24:59 mi + zu #70728# missing documentation marked + + Revision 1.1.1.1 1999/11/11 09:48:46 jsc + new + + +=============================================================================*/ +#endif |