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_XFormulaQuery_idl__
25#define __com_sun_star_sheet_XFormulaQuery_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_sheet_XSheetCellRanges_idl__
32#include <com/sun/star/sheet/XSheetCellRanges.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides methods to query cells for dependencies
42	in formulas.
43
44	<p>All methods return a collection of cell ranges.</p>
45
46	@see com::sun::star::sheet::SheetRangesQuery
47	@see com::sun::star::sheet::SheetCellRanges
48 */
49published interface XFormulaQuery: com::sun::star::uno::XInterface
50{
51	//-------------------------------------------------------------------------
52
53	/** queries all dependent formula cells.
54
55		<p>Dependent cells are cells containing formulas with references to
56		the original cell.</p>
57
58		@param bRecursive
59			<FALSE/> = queries cells dependent from the original range(s),
60			<TRUE/> = repeates query with all found cells
61			(finds dependents of dependents, and so on).
62
63		@return
64			all dependent cells of any formula cell of the current
65			cell range(s).
66	 */
67	com::sun::star::sheet::XSheetCellRanges queryDependents(
68			[in] boolean bRecursive );
69
70	//-------------------------------------------------------------------------
71
72	/** queries all precedent cells.
73
74		<p>Precedent cells are cells which are referenced from a formula
75		cell.</p>
76
77		@param bRecursive
78			<FALSE/> = queries precedent cells of the original range(s),
79			<TRUE/> = repeates query with all found cells
80			(finds precedents of precedents, and so on).
81
82		@return
83			all precedent cells of any formula cell of the current cell
84			range(s).
85	 */
86	com::sun::star::sheet::XSheetCellRanges queryPrecedents(
87			[in] boolean bRecursive );
88
89};
90
91//=============================================================================
92
93}; }; }; };
94
95#endif
96
97