offapi/com/sun/star/sheet/XFormulaQuery.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_XFormulaQuery_idl__
  21 #define __com_sun_star_sheet_XFormulaQuery_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/XSheetCellRanges.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides methods to query cells for dependencies
  31     in formulas.
  32
  33     <p>All methods return a collection of cell ranges.</p>
  34
  35     @see com::sun::star::sheet::SheetRangesQuery
  36     @see com::sun::star::sheet::SheetCellRanges
  37  */
  38 published interface XFormulaQuery: com::sun::star::uno::XInterface
  39 {
  40
  41     /** queries all dependent formula cells.
  42
  43         <p>Dependent cells are cells containing formulas with references to
  44         the original cell.</p>
  45
  46         @param bRecursive
  47             `FALSE` = queries cells dependent from the original range(s),
  48             `TRUE` = repeats query with all found cells
  49             (finds dependents of dependents, and so on).
  50
  51         @return
  52             all dependent cells of any formula cell of the current
  53             cell range(s).
  54      */
  55     com::sun::star::sheet::XSheetCellRanges queryDependents(
  56             [in] boolean bRecursive );
  57
  58
  59     /** queries all precedent cells.
  60
  61         <p>Precedent cells are cells which are referenced from a formula
  62         cell.</p>
  63
  64         @param bRecursive
  65             `FALSE` = queries precedent cells of the original range(s),
  66             `TRUE` = repeats query with all found cells
  67             (finds precedents of precedents, and so on).
  68
  69         @return
  70             all precedent cells of any formula cell of the current cell
  71             range(s).
  72      */
  73     com::sun::star::sheet::XSheetCellRanges queryPrecedents(
  74             [in] boolean bRecursive );
  75
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */