1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XCalculatable_idl__
29#define __com_sun_star_sheet_XCalculatable_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** represents something that can recalculate.
42 */
43published interface XCalculatable: com::sun::star::uno::XInterface
44{
45	//-------------------------------------------------------------------------
46
47	/** recalculates all dirty cells.
48
49		<p>This calculates all formula cells which have not yet been
50		calculated after their precedents have changed.</p>
51	 */
52	void calculate();
53
54	//-------------------------------------------------------------------------
55
56	/** recalculates all cells.
57	 */
58	void calculateAll();
59
60	//-------------------------------------------------------------------------
61
62	/** returns whether automatic calculation is enabled.
63
64		<p>With automatic calculation, each formula cell is recalculated
65		whenever its value is needed after its precedents have changed.
66		The value is needed if the cell is displayed or used in another
67		calculation.</p>
68
69		@returns
70			<TRUE/>, if automatic calculation is enabled.
71	 */
72	boolean isAutomaticCalculationEnabled();
73
74	//-------------------------------------------------------------------------
75
76	/** enables automatic calculation.
77
78		<p>With automatic calculation, each formula cell is recalculated
79		whenever its value is needed after its precedents have changed.
80		The value is needed if the cell is displayed or used in another
81		calculation.</p>
82
83		@param bEnabled
84			<TRUE/> to enable automatic calculation, <FALSE/> to disable.
85	 */
86	[oneway] void enableAutomaticCalculation( [in] boolean bEnabled );
87
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95
96