xref: /trunk/main/offapi/com/sun/star/sheet/XAreaLinks.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XAreaLinks_idl__
29#define __com_sun_star_sheet_XAreaLinks_idl__
30
31#ifndef __com_sun_star_container_XIndexAccess_idl__
32#include <com/sun/star/container/XIndexAccess.idl>
33#endif
34
35#ifndef __com_sun_star_table_CellAddress_idl__
36#include <com/sun/star/table/CellAddress.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** provides access via index to a collection of area links and inserting
46	and removing area links.
47
48	@see com::sun::star::sheet::CellAreaLinks
49	@see com::sun::star::sheet::CellAreaLink
50 */
51published interface XAreaLinks: com::sun::star::container::XIndexAccess
52{
53	//-------------------------------------------------------------------------
54
55	/** creates an area link and adds it to the collection.
56
57		@param aDestPos
58			the address of the first cell of the range inside the current
59			document.
60
61		@param aFileName
62			the URL of the source document.
63
64		@param aSourceArea
65			the name of the range in the source document.
66
67			<p>This can be the address of a cell or range in the form
68			"Sheet1.A1:C5", or the name of a named range or database range.</p>
69
70		@param aFilter
71			the name of the filter used to load the source document.
72
73		@param aFilterOptions
74			optional filter options for the specified filter.
75	 */
76	void insertAtPosition( [in] com::sun::star::table::CellAddress aDestPos,
77			 [in] string aFileName,
78			 [in] string aSourceArea,
79			 [in] string aFilter,
80			 [in] string aFilterOptions );
81
82	//-------------------------------------------------------------------------
83
84	/** removes an area link from the collection.
85	 */
86	void removeByIndex( [in] long nIndex );
87
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95
96