xref: /AOO41X/main/offapi/com/sun/star/sheet/XAreaLink.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_XAreaLink_idl__
25#define __com_sun_star_sheet_XAreaLink_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_table_CellRangeAddress_idl__
32#include <com/sun/star/table/CellRangeAddress.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides methods to change the settings of a linked cell range.
42
43    @see com::sun::star::sheet::CellAreaLink
44 */
45published interface XAreaLink: com::sun::star::uno::XInterface
46{
47    //-------------------------------------------------------------------------
48
49    /** returns the source of the range within the source document.
50
51        <p>This can be the address of a cell or range in the form
52        "Sheet1.A1:C5", or the name of a named range or database range.</p>
53     */
54    string getSourceArea();
55
56    //-------------------------------------------------------------------------
57
58    /** sets the source of the range within the source document.
59
60        <p>This can be the address of a cell or range in the form
61        "Sheet1.A1:C5", or the name of a named range or database range.</p>
62     */
63    void setSourceArea( [in] string aSourceArea );
64
65    //-------------------------------------------------------------------------
66
67    /** returns the position of the linked range in the destination
68        document.
69     */
70    com::sun::star::table::CellRangeAddress getDestArea();
71
72    //-------------------------------------------------------------------------
73
74    /** sets the position of the linked range in the destination document.
75     */
76    void setDestArea( [in] com::sun::star::table::CellRangeAddress aDestArea );
77
78};
79
80//=============================================================================
81
82}; }; }; };
83
84#endif
85
86