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