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#ifndef __com_sun_star_sheet_ExternalLinkInfo_idl__
24#define __com_sun_star_sheet_ExternalLinkInfo_idl__
25
26#ifndef __com_sun_star_sheet_ExternalLinkType_idl__
27#include <com/sun/star/sheet/ExternalLinkType.idl>
28#endif
29
30//=============================================================================
31
32module com {  module sun {  module star {  module sheet {
33
34//=============================================================================
35/** describes an external link in a formula.
36
37    @since OpenOffice 3.1
38 */
39struct ExternalLinkInfo
40{
41    //-------------------------------------------------------------------------
42    /** Link type, one of <type>ExternalLinkType</type> constants.
43     */
44    long Type;
45
46    //-------------------------------------------------------------------------
47    /** Location of this link type.
48
49        <p>Modes used:
50
51        <ol>
52        <li>If <member>Type</member> is <const>ExternalLinkType::EXTERNAL
53        </const>, this member shall contain a <atom>string</atom> with the
54        <em>URI</em> of a document. The formula that would need this
55        information for example would contain <code>=[1]Sheet1!A1</code> or
56        <code>='[1]Sheet name'!A1</code> where <em>[1]</em> does resolve to
57        the URI contained in the member <member>Data</member>. Note that the
58        quotes cover both, the document name and the sheet name.</li>
59
60        <li>If <member>Type</member> is <const>ExternalLinkType::DDE</const>,
61        this member shall contain a <type>DDELinkInfo</type> describing
62        service name, topic, and all known items of a DDE link.</li>
63        </ol></p>
64     */
65    any Data;
66
67};
68
69//=============================================================================
70
71}; }; }; };
72
73#endif
74