xref: /trunk/main/offapi/com/sun/star/sheet/XAreaLinks.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XAreaLinks_idl__
25#define __com_sun_star_sheet_XAreaLinks_idl__
26
27#ifndef __com_sun_star_container_XIndexAccess_idl__
28#include <com/sun/star/container/XIndexAccess.idl>
29#endif
30
31#ifndef __com_sun_star_table_CellAddress_idl__
32#include <com/sun/star/table/CellAddress.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides access via index to a collection of area links and inserting
42	and removing area links.
43
44	@see com::sun::star::sheet::CellAreaLinks
45	@see com::sun::star::sheet::CellAreaLink
46 */
47published interface XAreaLinks: com::sun::star::container::XIndexAccess
48{
49	//-------------------------------------------------------------------------
50
51	/** creates an area link and adds it to the collection.
52
53		@param aDestPos
54			the address of the first cell of the range inside the current
55			document.
56
57		@param aFileName
58			the URL of the source document.
59
60		@param aSourceArea
61			the name of the range in the source document.
62
63			<p>This can be the address of a cell or range in the form
64			"Sheet1.A1:C5", or the name of a named range or database range.</p>
65
66		@param aFilter
67			the name of the filter used to load the source document.
68
69		@param aFilterOptions
70			optional filter options for the specified filter.
71	 */
72	void insertAtPosition( [in] com::sun::star::table::CellAddress aDestPos,
73			 [in] string aFileName,
74			 [in] string aSourceArea,
75			 [in] string aFilter,
76			 [in] string aFilterOptions );
77
78	//-------------------------------------------------------------------------
79
80	/** removes an area link from the collection.
81	 */
82	void removeByIndex( [in] long nIndex );
83
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91
92