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