offapi/com/sun/star/sheet/XFormulaQuery.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: XFormulaQuery.idl,v $
  10  * $Revision: 1.9 $
  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_XFormulaQuery_idl__
  32 #define __com_sun_star_sheet_XFormulaQuery_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_sheet_XSheetCellRanges_idl__
  39 #include <com/sun/star/sheet/XSheetCellRanges.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides methods to query cells for dependencies
  49     in formulas.
  50
  51     <p>All methods return a collection of cell ranges.</p>
  52
  53     @see com::sun::star::sheet::SheetRangesQuery
  54     @see com::sun::star::sheet::SheetCellRanges
  55  */
  56 published interface XFormulaQuery: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** queries all dependent formula cells.
  61
  62         <p>Dependent cells are cells containing formulas with references to
  63         the original cell.</p>
  64
  65         @param bRecursive
  66             <FALSE/> = queries cells dependent from the original range(s),
  67             <TRUE/> = repeates query with all found cells
  68             (finds dependents of dependents, and so on).
  69
  70         @return
  71             all dependent cells of any formula cell of the current
  72             cell range(s).
  73      */
  74     com::sun::star::sheet::XSheetCellRanges queryDependents(
  75             [in] boolean bRecursive );
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** queries all precedent cells.
  80
  81         <p>Precedent cells are cells which are referenced from a formula
  82         cell.</p>
  83
  84         @param bRecursive
  85             <FALSE/> = queries precedent cells of the original range(s),
  86             <TRUE/> = repeates query with all found cells
  87             (finds precedents of precedents, and so on).
  88
  89         @return
  90             all precedent cells of any formula cell of the current cell
  91             range(s).
  92      */
  93     com::sun::star::sheet::XSheetCellRanges queryPrecedents(
  94             [in] boolean bRecursive );
  95
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif
 103