offapi/com/sun/star/sheet/XCellRangesQuery.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: XCellRangesQuery.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_XCellRangesQuery_idl__
  32 #define __com_sun_star_sheet_XCellRangesQuery_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 #ifndef __com_sun_star_table_CellAddress_idl__
  43 #include <com/sun/star/table/CellAddress.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  47 #include <com/sun/star/table/CellRangeAddress.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sheet {
  53
  54 //=============================================================================
  55
  56 /** provides methods to query for cell ranges with specific contents.
  57
  58     <p>All methods return a collection of cell ranges.</p>
  59
  60     @see com::sun::star::sheet::SheetRangesQuery
  61     @see com::sun::star::sheet::SheetCellRanges
  62  */
  63 published interface XCellRangesQuery: com::sun::star::uno::XInterface
  64 {
  65     //-------------------------------------------------------------------------
  66
  67     /** queries all visible cells.
  68
  69         @returns
  70             the visible (not hidden) cells of the current cell range(s).
  71      */
  72     com::sun::star::sheet::XSheetCellRanges queryVisibleCells();
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** queries all empty cells.
  77
  78         @returns
  79             the empty cells of the current cell range(s).
  80      */
  81     com::sun::star::sheet::XSheetCellRanges queryEmptyCells();
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** queries all cells with the specified content type(s).
  86
  87         @param nContentFlags
  88             a combination of <type>CellFlags</type> flags.
  89
  90             <p>Attention: Despite the <type>CellFlags</type> flags are
  91             <atom>long</atom> values, this method expects a <atom>short</atom>
  92             parameter.
  93
  94         @returns
  95             all cells of the current cell range(s) with the specified
  96             content type(s).
  97      */
  98     com::sun::star::sheet::XSheetCellRanges queryContentCells(
  99             [in] short nContentFlags );
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** queries all formula cells with the specified result type.
 104
 105         @param nResultFlags
 106             a combination of <type>FormulaResult</type> flags.
 107
 108         @returns
 109             all formula cells of the current cell range(s) with the
 110             specified result type(s).
 111      */
 112     com::sun::star::sheet::XSheetCellRanges queryFormulaCells(
 113             [in] long nResultFlags );
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** queries all cells with different values in a specified row.
 118
 119         <p>This method takes each column of the current cell range(s) and
 120         compares all cells with the cell in the specified row. All cells
 121         which are different to this comparison cell will be returned.</p>
 122
 123         @param aCompare
 124             contains a cell address with the row index used for comparison.
 125             Only this row index is of interest.
 126
 127         @returns
 128             all cells of the current cell range(s) which are different
 129             to the comparison cell of each column.
 130      */
 131     com::sun::star::sheet::XSheetCellRanges queryColumnDifferences(
 132             [in] com::sun::star::table::CellAddress aCompare );
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** queries all cells with different values in a specified column.
 137
 138         <p>This method takes each row of the current cell range(s) and
 139         compares all cells with the cell in the specified column. All cells
 140         which are different to this comparison cell will be returned.</p>
 141
 142         @param aCompare
 143             contains a cell address with the column index used for
 144             comparison. Only this column index is of interest.
 145
 146         @returns
 147             all cells of the current cell range(s) which are different
 148             to the comparison cell of each row.
 149      */
 150     com::sun::star::sheet::XSheetCellRanges queryRowDifferences(
 151             [in] com::sun::star::table::CellAddress aCompare );
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** intersects the current cell range(s) with the specified cell range.
 156
 157         @param aRange
 158             contains the cell range for intersection.
 159
 160         @return
 161             all cells of the current cell range(s) which are contained
 162             in the passed cell range.
 163
 164      */
 165     com::sun::star::sheet::XSheetCellRanges queryIntersection(
 166             [in] com::sun::star::table::CellRangeAddress aRange );
 167
 168 };
 169
 170 //=============================================================================
 171
 172 }; }; }; };
 173
 174 #endif
 175