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_ExternalReference_idl__
25#define __com_sun_star_sheet_ExternalReference_idl__
26
27module com {  module sun {  module star {  module sheet {
28
29//=============================================================================
30
31/** Data structure to store information about an external reference.  An
32    external reference can be either a single cell reference, a cell range
33    reference, or a named range.
34
35    @see FormulaMapGroupSpecialOffset::PUSH
36
37    @since OpenOffice 3.1
38 */
39struct ExternalReference
40{
41    //-------------------------------------------------------------------------
42
43    /** Index of an externally linked document.  Each externally-linked document
44        has a unique index value.
45
46        <p>You can get the index value of an external document from the
47        corresponding <type scope="com::sun::star::sheet">ExternalDocLink</type>
48        instance through its attribute <type scope="com::sun::star::sheet::ExternalDocLink">TokenIndex</type>.</p>
49
50        @see com::sun::star::sheet::ExternalDocLink
51        @see com::sun::star::sheet::ExternalDocLink::TokenIndex
52     */
53    long Index;
54
55#if 0
56    //-------------------------------------------------------------------------
57
58    /** Name of the sheet that the external reference points to.
59
60        <p>In case of a cell range reference that spans across multiple
61        sheets, this is the name of the first sheet in that range.</p>
62
63        <p>Note that an external range name ignores this value at the moment,
64        but <i>it may make use of this data in the future when Calc supports a
65        sheet-specific range name.</i></p>
66     */
67    string SheetName;
68#endif
69
70    //-------------------------------------------------------------------------
71
72    /** Reference data.
73
74        <p>This can store either <type>SingleReference</type> for a single
75        cell reference, <type>ComplexReference</type> for a cell range
76        reference, or simply a <type>string</type> for a defined name.</p>
77
78        <p>The <member>SingleReference::Sheet</member> member shall contain
79        the index of the external sheet cache containing the values of the
80        externally referenced cells.</p>
81
82        @see com::sun::star::sheet::SingleReference
83        @see com::sun::star::sheet::ComplexReference
84     */
85    any Reference;
86};
87
88//=============================================================================
89
90}; }; }; };
91
92#endif
93