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_XSheetAuditing_idl__
29#define __com_sun_star_sheet_XSheetAuditing_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_table_CellAddress_idl__
36#include <com/sun/star/table/CellAddress.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** provides methods to access auditing (detective) features in a
46	spreadsheet.
47 */
48published interface XSheetAuditing: com::sun::star::uno::XInterface
49{
50	//-------------------------------------------------------------------------
51
52	/** removes arrows for one level of dependents of a formula cell.
53
54		<p>If the method is executed again for the same cell, the previous
55		level of dependent cells is removed.</p>
56
57		@param aPosition
58			the address of the formula cell.
59	 */
60	boolean hideDependents( [in] com::sun::star::table::CellAddress aPosition );
61
62	//-------------------------------------------------------------------------
63
64	/** removes arrows for one level of precedents of a formula cell.
65
66		<p>If the method is executed again for the same cell, the previous
67		level of dependent cells is removed.</p>
68
69		@param aPosition
70			the address of the formula cell.
71	 */
72	boolean hidePrecedents( [in] com::sun::star::table::CellAddress aPosition );
73
74	//-------------------------------------------------------------------------
75
76	/** draws arrows between a formula cell and its dependents.
77
78		<p>If the method is executed again for the same cell, the next
79		level of dependent cells is marked.</p>
80
81		@param aPosition
82			the address of the formula cell.
83	 */
84	boolean showDependents( [in] com::sun::star::table::CellAddress aPosition );
85
86	//-------------------------------------------------------------------------
87
88	/** draws arrows between a formula cell and its precedents.
89
90		<p>If the method is executed again for the same cell, the next
91		level of dependent cells is marked.</p>
92
93		@param aPosition
94			the address of the formula cell.
95	 */
96	boolean showPrecedents( [in] com::sun::star::table::CellAddress aPosition );
97
98	//-------------------------------------------------------------------------
99
100	/** draws arrows between a formula cell containing an error
101		and the cells causing the error.
102	 */
103	boolean showErrors( [in] com::sun::star::table::CellAddress aPosition );
104
105	//-------------------------------------------------------------------------
106
107	/** marks all cells containing invalid values.
108	 */
109	boolean showInvalid();
110
111	//-------------------------------------------------------------------------
112
113	/** removes all auditing arrows from the spreadsheet.
114	 */
115	void clearArrows();
116
117};
118
119//=============================================================================
120
121}; }; }; };
122
123#endif
124
125