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_sheet_XCalculatable_idl__
25#define __com_sun_star_sheet_XCalculatable_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module sheet {
34
35//=============================================================================
36
37/** represents something that can recalculate.
38 */
39published interface XCalculatable: com::sun::star::uno::XInterface
40{
41	//-------------------------------------------------------------------------
42
43	/** recalculates all dirty cells.
44
45		<p>This calculates all formula cells which have not yet been
46		calculated after their precedents have changed.</p>
47	 */
48	void calculate();
49
50	//-------------------------------------------------------------------------
51
52	/** recalculates all cells.
53	 */
54	void calculateAll();
55
56	//-------------------------------------------------------------------------
57
58	/** returns whether automatic calculation is enabled.
59
60		<p>With automatic calculation, each formula cell is recalculated
61		whenever its value is needed after its precedents have changed.
62		The value is needed if the cell is displayed or used in another
63		calculation.</p>
64
65		@returns
66			<TRUE/>, if automatic calculation is enabled.
67	 */
68	boolean isAutomaticCalculationEnabled();
69
70	//-------------------------------------------------------------------------
71
72	/** enables automatic calculation.
73
74		<p>With automatic calculation, each formula cell is recalculated
75		whenever its value is needed after its precedents have changed.
76		The value is needed if the cell is displayed or used in another
77		calculation.</p>
78
79		@param bEnabled
80			<TRUE/> to enable automatic calculation, <FALSE/> to disable.
81	 */
82	[oneway] void enableAutomaticCalculation( [in] boolean bEnabled );
83
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91
92