/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XAreaLinks_idl__
#define __com_sun_star_sheet_XAreaLinks_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

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

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

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

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

/** provides access via index to a collection of area links and inserting
	and removing area links.

	@see com::sun::star::sheet::CellAreaLinks
	@see com::sun::star::sheet::CellAreaLink
 */
published interface XAreaLinks: com::sun::star::container::XIndexAccess
{
	//-------------------------------------------------------------------------

	/** creates an area link and adds it to the collection.

		@param aDestPos
			the address of the first cell of the range inside the current
			document.

		@param aFileName
			the URL of the source document.

		@param aSourceArea
			the name of the range in the source document.

			<p>This can be the address of a cell or range in the form
			"Sheet1.A1:C5", or the name of a named range or database range.</p>

		@param aFilter
			the name of the filter used to load the source document.

		@param aFilterOptions
			optional filter options for the specified filter.
	 */
	void insertAtPosition( [in] com::sun::star::table::CellAddress aDestPos,
			 [in] string aFileName,
			 [in] string aSourceArea,
			 [in] string aFilter,
			 [in] string aFilterOptions );

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

	/** removes an area link from the collection.
	 */
	void removeByIndex( [in] long nIndex );

};

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

}; }; }; };

#endif