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