xref: /AOO41X/main/offapi/com/sun/star/sheet/CellAreaLink.idl (revision fbef625e460ef3feded438b39e36a4c8f360d8f1)
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_CellAreaLink_idl__
25#define __com_sun_star_sheet_CellAreaLink_idl__
26
27#ifndef __com_sun_star_sheet_XAreaLink_idl__
28#include <com/sun/star/sheet/XAreaLink.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 linked cell range.
46
47    <p>A linked cell range is a range which is linked to an equal-sized
48    range in an external document. The contents of the external range is
49    copied into the range of this document.</p>
50
51    @see com::sun::star::sheet::CellAreaLinks
52 */
53published service CellAreaLink
54{
55    //-------------------------------------------------------------------------
56
57    /** provides methods to change the settings of the linked cell range.
58     */
59    interface com::sun::star::sheet::XAreaLink;
60
61    //-------------------------------------------------------------------------
62
63    /** provides methods to reload the external data.
64     */
65    interface com::sun::star::util::XRefreshable;
66
67    //-------------------------------------------------------------------------
68
69//!published service PropertySet
70    /** provides access to the properties.
71     */
72    interface com::sun::star::beans::XPropertySet;
73
74     //========================================================================
75
76    /** specifies the URL of the source document.
77     */
78    [property] string Url;
79
80    //-------------------------------------------------------------------------
81
82    /** specifies the name of the filter used to load the source document.
83     */
84    [property] string Filter;
85
86    //-------------------------------------------------------------------------
87
88    /** specifies the filter options needed to load the source document.
89     */
90    [property] string FilterOptions;
91
92    //-------------------------------------------------------------------------
93
94    /** specifies the delay time between two refresh actions in seconds.
95
96    @deprecated
97
98     */
99    [property] long RefreshDelay;
100
101    //-------------------------------------------------------------------------
102
103    /** specifies the time between two refresh actions in seconds.
104
105        @since OpenOffice 2.0
106     */
107    [optional, property] long RefreshPeriod;
108
109
110};
111
112//=============================================================================
113
114}; }; }; };
115
116#endif
117
118