/*************************************************************************
 *
 *  $RCSfile: XSheetCellRangeContainer.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:08:25 $
 *
 *  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_XSheetCellRangeContainer_idl__
#define __com_sun_star_sheet_XSheetCellRangeContainer_idl__

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

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

#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif

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

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

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

/** provides methods to access cell ranges in a collection via index and
	to add and remove cell ranges.

	@see com::sun::star::sheet::SheetCellRanges
 */
interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges
{
	//-------------------------------------------------------------------------

	/** adds the given range to the collection of cell ranges.

		@param aCellRangeAddress
			contains the address of the new range.

		@param bMergeRanges
			defines how the range should be added. To merge the ranges
			takes more time, but the memory usage is lower.
	 */
	void addRangeAddress(
			[in] com::sun::star::table::CellRangeAddress aCellRangeAddress,
			[in] boolean bMergeRanges );

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

	/** removes the given range from the collection of cell ranges.

		@param aCellRangeAddress
			contains the address of the range to be removed.

			<p>The specified range must fit exactly to an element of the
			collection. The method does not try to shorten a range.</p>

		@throws <type scope="com::sun::star::container">NoSuchElementException</type>
			if the collection does not contain the specified range.
	 */
	void removeRangeAddress(
			[in] com::sun::star::table::CellRangeAddress aCellRangeAddress )
		raises( com::sun::star::container::NoSuchElementException );

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

	/** adds the given ranges to the collection of cell ranges.

		@param aCellRangeAddresses
			contains a sequence of addresses of all new ranges.

		@param bMergeRanges
			defines how the ranges should be added. To merge the ranges
			takes more time, but the memory usage is lower.
	 */
	void addRangeAddresses(
			[in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses,
			[in] boolean bMergeRanges );

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

	/** removes the given ranges from the collection of cell ranges.

		@param aCellRangeAddresses
			contains a sequence of addresses of all ranges to be removed.

			<p>All specified ranges must fit exactly to elements of the
			collection. The method does not try to shorten ranges.</p>

		@throws <type scope="com::sun::star::container">NoSuchElementException</type>
			if the collection does not contain any of the specified ranges.
	 */
	void removeRangeAddresses(
			[in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses )
		raises( com::sun::star::container::NoSuchElementException);

};

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

}; }; }; };

#endif

