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