offapi/com/sun/star/sheet/XCellRangesQuery.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 for cell ranges with specific contents.
  25
  26     <p>All methods return a collection of cell ranges.</p>
  27
  28     @see com::sun::star::sheet::SheetRangesQuery
  29     @see com::sun::star::sheet::SheetCellRanges
  30  */
  31 published interface XCellRangesQuery: com::sun::star::uno::XInterface
  32 {
  33
  34     /** queries all visible cells.
  35
  36         @returns
  37             the visible (not hidden) cells of the current cell range(s).
  38      */
  39     com::sun::star::sheet::XSheetCellRanges queryVisibleCells();
  40
  41
  42     /** queries all empty cells.
  43
  44         @returns
  45             the empty cells of the current cell range(s).
  46      */
  47     com::sun::star::sheet::XSheetCellRanges queryEmptyCells();
  48
  49
  50     /** queries all cells with the specified content type(s).
  51
  52         @param nContentFlags
  53             a combination of CellFlags flags.
  54
  55             <p>Attention: Despite the CellFlags flags are
  56             `long` values, this method expects a `short`
  57             parameter.</p>
  58
  59             <p>Attention: Empty cells in the range may be skipped depending on
  60             the content flag used.  For instance, when querying for STYLES,
  61             the returned ranges may not include empty cells even if styles are
  62             applied to those cells.</p>
  63
  64         @returns
  65             all cells of the current cell range(s) with the specified
  66             content type(s).
  67      */
  68     com::sun::star::sheet::XSheetCellRanges queryContentCells(
  69             [in] short nContentFlags );
  70
  71
  72     /** queries all formula cells with the specified result type.
  73
  74         @param nResultFlags
  75             a combination of FormulaResult flags.
  76
  77         @returns
  78             all formula cells of the current cell range(s) with the
  79             specified result type(s).
  80      */
  81     com::sun::star::sheet::XSheetCellRanges queryFormulaCells(
  82             [in] long nResultFlags );
  83
  84
  85     /** queries all cells with different values in a specified row.
  86
  87         <p>This method takes each column of the current cell range(s) and
  88         compares all cells with the cell in the specified row. All cells
  89         which are different to this comparison cell will be returned.</p>
  90
  91         @param aCompare
  92             contains a cell address with the row index used for comparison.
  93             Only this row index is of interest.
  94
  95         @returns
  96             all cells of the current cell range(s) which are different
  97             to the comparison cell of each column.
  98      */
  99     com::sun::star::sheet::XSheetCellRanges queryColumnDifferences(
 100             [in] com::sun::star::table::CellAddress aCompare );
 101
 102
 103     /** queries all cells with different values in a specified column.
 104
 105         <p>This method takes each row of the current cell range(s) and
 106         compares all cells with the cell in the specified column. All cells
 107         which are different to this comparison cell will be returned.</p>
 108
 109         @param aCompare
 110             contains a cell address with the column index used for
 111             comparison. Only this column index is of interest.
 112
 113         @returns
 114             all cells of the current cell range(s) which are different
 115             to the comparison cell of each row.
 116      */
 117     com::sun::star::sheet::XSheetCellRanges queryRowDifferences(
 118             [in] com::sun::star::table::CellAddress aCompare );
 119
 120
 121     /** intersects the current cell range(s) with the specified cell range.
 122
 123         @param aRange
 124             contains the cell range for intersection.
 125
 126         @return
 127             all cells of the current cell range(s) which are contained
 128             in the passed cell range.
 129
 130      */
 131     com::sun::star::sheet::XSheetCellRanges queryIntersection(
 132             [in] com::sun::star::table::CellRangeAddress aRange );
 133
 134 };
 135
 136
 137 }; }; }; };
 138
 139 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */