xref: /aoo41x/main/offapi/com/sun/star/sheet/XAreaLinks.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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