xref: /aoo4110/main/offapi/com/sun/star/table/XCell.idl (revision b1cdbd2c) 
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_table_XCell_idl__
25#define __com_sun_star_table_XCell_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_table_CellContentType_idl__
32#include <com/sun/star/table/CellContentType.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module table {
38
39//=============================================================================
40
41/** provides methods to access the contents of a cell in a table.
42
43	@see com::sun::star::table::Cell
44 */
45published interface XCell: com::sun::star::uno::XInterface
46{
47	//-------------------------------------------------------------------------
48
49	/** returns the formula string of a cell.
50
51		<p>Even if the cell does not contain a formula, an assignment of
52		this attribute's value to another cell's formula attribute would
53		create the same cell content. This is because this attribute contains
54		the original text value of a string cell. The value of a
55		<em>value cell</em> will be formatted using the number format's
56		default format or the formula string, including "=", of a formula
57		cell.</p>
58	 */
59	string getFormula();
60
61	//-------------------------------------------------------------------------
62
63	/** sets a formula into the cell.
64
65		<p>When assigned, the string will be interpreted and a value, text
66		or formula cell is created, depending on the text and the number
67		format.</p>
68	 */
69	void setFormula( [in] string aFormula );
70
71	//-------------------------------------------------------------------------
72
73	/** returns the floating point value of the cell.
74
75		<p>For a <em>value cell</em> the value is returnd, for a
76		<em>string cell</em> zero is returned and for a <em>formula cell</em>
77		the result value of a formula is returned.</p>
78	 */
79	double getValue();
80
81	//-------------------------------------------------------------------------
82
83	/** sets a floating point value into the cell.
84
85		<p>After a call to this method the type of the cell is
86		<member>CellContentType::VALUE</member>.</p>
87	 */
88	void setValue( [in] double nValue );
89
90	//-------------------------------------------------------------------------
91
92	/** returns the type of the cell.
93	 */
94	com::sun::star::table::CellContentType getType();
95
96	//-------------------------------------------------------------------------
97
98	/** returns the error value of the cell.
99
100		<P>If the cell does not contain a formula, the error is always
101		zero.</p>
102	 */
103	long getError();
104
105};
106
107//=============================================================================
108
109}; }; }; };
110
111#endif
112
113