xref: /aoo42x/main/offapi/com/sun/star/sheet/SheetLink.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_SheetLink_idl__
25#define __com_sun_star_sheet_SheetLink_idl__
26
27#ifndef __com_sun_star_container_XNamed_idl__
28#include <com/sun/star/container/XNamed.idl>
29#endif
30
31#ifndef __com_sun_star_util_XRefreshable_idl__
32#include <com/sun/star/util/XRefreshable.idl>
33#endif
34
35#ifndef __com_sun_star_beans_XPropertySet_idl__
36#include <com/sun/star/beans/XPropertySet.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** represents a sheet link.
46
47	<p>A sheet link contains the source data of linked sheets, i.e. the
48	URL and sheet name of the external document.</p>
49
50	<p>To create a linked sheet, the sheet which will be used as linked
51	sheet has to exist already. The method
52	<member>XSheetLinkable::link</member> creates a <type>SheetLink</type>
53	object in the document's <type>SheetLinks</type> collection and links
54	the sheet to the specified external sheet.</p>
55 */
56published service SheetLink
57{
58	//-------------------------------------------------------------------------
59
60	/** provides access to the name of the linked document.
61
62		<p>This name is equal to the <const>Url</const> property.</p>
63	 */
64	interface com::sun::star::container::XNamed;
65
66	//-------------------------------------------------------------------------
67
68	/** provides methods to reload the external data.
69	 */
70	interface com::sun::star::util::XRefreshable;
71
72	//-------------------------------------------------------------------------
73
74//!published service PropertySet
75	/** provides access to the properties.
76	 */
77	interface com::sun::star::beans::XPropertySet;
78
79	//=========================================================================
80
81	/** specifies the URL of the source document.
82	 */
83	[property] string Url;
84
85	//-------------------------------------------------------------------------
86
87	/** specifies the name of the filter needed to load the source
88		document.
89	 */
90	[property] string Filter;
91
92	//-------------------------------------------------------------------------
93
94	/** specifies the filter options needed to load the source document.
95	 */
96	[property] string FilterOptions;
97
98};
99
100//=============================================================================
101
102}; }; }; };
103
104#endif
105
106