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