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 #ifndef __com_sun_star_sheet_XSheetAuditing_idl__
  21 #define __com_sun_star_sheet_XSheetAuditing_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/table/CellAddress.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides methods to access auditing (detective) features in a
  31     spreadsheet.
  32  */
  33 published interface XSheetAuditing: com::sun::star::uno::XInterface
  34 {
  35
  36     /** removes arrows for one level of dependents of a formula cell.
  37
  38         <p>If the method is executed again for the same cell, the previous
  39         level of dependent cells is removed.</p>
  40
  41         @param aPosition
  42             the address of the formula cell.
  43      */
  44     boolean hideDependents( [in] com::sun::star::table::CellAddress aPosition );
  45
  46
  47     /** removes arrows for one level of precedents of a formula cell.
  48
  49         <p>If the method is executed again for the same cell, the previous
  50         level of dependent cells is removed.</p>
  51
  52         @param aPosition
  53             the address of the formula cell.
  54      */
  55     boolean hidePrecedents( [in] com::sun::star::table::CellAddress aPosition );
  56
  57
  58     /** draws arrows between a formula cell and its dependents.
  59
  60         <p>If the method is executed again for the same cell, the next
  61         level of dependent cells is marked.</p>
  62
  63         @param aPosition
  64             the address of the formula cell.
  65      */
  66     boolean showDependents( [in] com::sun::star::table::CellAddress aPosition );
  67
  68
  69     /** draws arrows between a formula cell and its precedents.
  70
  71         <p>If the method is executed again for the same cell, the next
  72         level of dependent cells is marked.</p>
  73
  74         @param aPosition
  75             the address of the formula cell.
  76      */
  77     boolean showPrecedents( [in] com::sun::star::table::CellAddress aPosition );
  78
  79
  80     /** draws arrows between a formula cell containing an error
  81         and the cells causing the error.
  82      */
  83     boolean showErrors( [in] com::sun::star::table::CellAddress aPosition );
  84
  85
  86     /** marks all cells containing invalid values.
  87      */
  88     boolean showInvalid();
  89
  90
  91     /** removes all auditing arrows from the spreadsheet.
  92      */
  93     void clearArrows();
  94
  95 };
  96
  97
  98 }; }; }; };
  99
 100 #endif
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */