offapi/com/sun/star/sheet/XSheetAuditing.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** provides methods to access auditing (detective) features in a
  25     spreadsheet.
  26  */
  27 published interface XSheetAuditing: com::sun::star::uno::XInterface
  28 {
  29
  30     /** removes arrows for one level of dependents of a formula cell.
  31
  32         <p>If the method is executed again for the same cell, the previous
  33         level of dependent cells is removed.</p>
  34
  35         @param aPosition
  36             the address of the formula cell.
  37      */
  38     boolean hideDependents( [in] com::sun::star::table::CellAddress aPosition );
  39
  40
  41     /** removes arrows for one level of precedents of a formula cell.
  42
  43         <p>If the method is executed again for the same cell, the previous
  44         level of dependent cells is removed.</p>
  45
  46         @param aPosition
  47             the address of the formula cell.
  48      */
  49     boolean hidePrecedents( [in] com::sun::star::table::CellAddress aPosition );
  50
  51
  52     /** draws arrows between a formula cell and its dependents.
  53
  54         <p>If the method is executed again for the same cell, the next
  55         level of dependent cells is marked.</p>
  56
  57         @param aPosition
  58             the address of the formula cell.
  59      */
  60     boolean showDependents( [in] com::sun::star::table::CellAddress aPosition );
  61
  62
  63     /** draws arrows between a formula cell and its precedents.
  64
  65         <p>If the method is executed again for the same cell, the next
  66         level of dependent cells is marked.</p>
  67
  68         @param aPosition
  69             the address of the formula cell.
  70      */
  71     boolean showPrecedents( [in] com::sun::star::table::CellAddress aPosition );
  72
  73
  74     /** draws arrows between a formula cell containing an error
  75         and the cells causing the error.
  76      */
  77     boolean showErrors( [in] com::sun::star::table::CellAddress aPosition );
  78
  79
  80     /** marks all cells containing invalid values.
  81      */
  82     boolean showInvalid();
  83
  84
  85     /** removes all auditing arrows from the spreadsheet.
  86      */
  87     void clearArrows();
  88
  89 };
  90
  91
  92 }; }; }; };
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */