/*************************************************************************
 *
 *  $RCSfile: XCellRangesQuery.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:08:15 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XCellRangesQuery_idl__
#define __com_sun_star_sheet_XCellRangesQuery_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__
#include <com/sun/star/sheet/XSheetCellRanges.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides methods to query for cell ranges with specific contents.

	<p>All methods return a collection of cell ranges.</p>

	@see com::sun::star::sheet::SheetRangesQuery
	@see com::sun::star::sheet::SheetCellRanges
 */
interface XCellRangesQuery: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** queries all visible cells.

		@returns
			the visible (not hidden) cells of the current cell range(s).
	 */
	com::sun::star::sheet::XSheetCellRanges queryVisibleCells();

	//-------------------------------------------------------------------------

	/** queries all empty cells.

		@returns
			the empty cells of the current cell range(s).
	 */
	com::sun::star::sheet::XSheetCellRanges queryEmptyCells();

	//-------------------------------------------------------------------------

	/** queries all cells with the specified content type(s).

		@param nContentFlags
			a combination of <type>CellFlags</type> flags.

			<p>Attention: Despite the <type>CellFlags</type> flags are
			<atom>long</atom> values, this method expects a <atom>short</atom>
			parameter.

		@returns
			all cells of the current cell range(s) with the specified
			content type(s).
	 */
	com::sun::star::sheet::XSheetCellRanges queryContentCells(
			[in] short nContentFlags );

	//-------------------------------------------------------------------------

	/** queries all formula cells with the specified result type.

		@param nResultFlags
			a combination of <type>FormulaResult</type> flags.

		@returns
			all formula cells of the current cell range(s) with the
			specified result type(s).
	 */
	com::sun::star::sheet::XSheetCellRanges queryFormulaCells(
			[in] long nResultFlags );

	//-------------------------------------------------------------------------

	/** queries all cells with different values in a specified row.

		<p>This method takes each column of the current cell range(s) and
		compares all cells with the cell in the specified row. All cells
		which are different to this comparison cell will be returned.</p>

		@param aCompare
			contains a cell address with the row index used for comparison.
			Only this row index is of interest.

		@returns
			all cells of the current cell range(s) which are different
			to the comparison cell of each column.
	 */
	com::sun::star::sheet::XSheetCellRanges queryColumnDifferences(
			[in] com::sun::star::table::CellAddress aCompare );

	//-------------------------------------------------------------------------

	/** queries all cells with different values in a specified column.

		<p>This method takes each row of the current cell range(s) and
		compares all cells with the cell in the specified column. All cells
		which are different to this comparison cell will be returned.</p>

		@param aCompare
			contains a cell address with the column index used for
			comparison. Only this column index is of interest.

		@returns
			all cells of the current cell range(s) which are different
			to the comparison cell of each row.
	 */
	com::sun::star::sheet::XSheetCellRanges queryRowDifferences(
			[in] com::sun::star::table::CellAddress aCompare );

	//-------------------------------------------------------------------------

	/** intersects the current cell range(s) with the specified cell range.

		@param aRange
			contains the cell range for intersection.

		@return
			all cells of the current cell range(s) which are contained
			in the passed cell range.

	 */
	com::sun::star::sheet::XSheetCellRanges queryIntersection(
			[in] com::sun::star::table::CellRangeAddress aRange );

};

//=============================================================================

}; }; }; };

#endif

