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