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