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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSheetAuditing.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_XSheetAuditing_idl__
  32 #define __com_sun_star_sheet_XSheetAuditing_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellAddress_idl__
  39 #include <com/sun/star/table/CellAddress.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides methods to access auditing (detective) features in a
  49     spreadsheet.
  50  */
  51 published interface XSheetAuditing: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** removes arrows for one level of dependents of a formula cell.
  56
  57         <p>If the method is executed again for the same cell, the previous
  58         level of dependent cells is removed.</p>
  59
  60         @param aPosition
  61             the address of the formula cell.
  62      */
  63     boolean hideDependents( [in] com::sun::star::table::CellAddress aPosition );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** removes arrows for one level of precedents of a formula cell.
  68
  69         <p>If the method is executed again for the same cell, the previous
  70         level of dependent cells is removed.</p>
  71
  72         @param aPosition
  73             the address of the formula cell.
  74      */
  75     boolean hidePrecedents( [in] com::sun::star::table::CellAddress aPosition );
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** draws arrows between a formula cell and its dependents.
  80
  81         <p>If the method is executed again for the same cell, the next
  82         level of dependent cells is marked.</p>
  83
  84         @param aPosition
  85             the address of the formula cell.
  86      */
  87     boolean showDependents( [in] com::sun::star::table::CellAddress aPosition );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** draws arrows between a formula cell and its precedents.
  92
  93         <p>If the method is executed again for the same cell, the next
  94         level of dependent cells is marked.</p>
  95
  96         @param aPosition
  97             the address of the formula cell.
  98      */
  99     boolean showPrecedents( [in] com::sun::star::table::CellAddress aPosition );
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** draws arrows between a formula cell containing an error
 104         and the cells causing the error.
 105      */
 106     boolean showErrors( [in] com::sun::star::table::CellAddress aPosition );
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** marks all cells containing invalid values.
 111      */
 112     boolean showInvalid();
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** removes all auditing arrows from the spreadsheet.
 117      */
 118     void clearArrows();
 119
 120 };
 121
 122 //=============================================================================
 123
 124 }; }; }; };
 125
 126 #endif
 127