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_DDELinkInfo_idl__
24#define __com_sun_star_sheet_DDELinkInfo_idl__
25
26#ifndef __com_sun_star_sheet_DDEItemInfo_idl__
27#include <com/sun/star/sheet/DDEItemInfo.idl>
28#endif
29
30//=============================================================================
31
32module com {  module sun {  module star {  module sheet {
33
34//=============================================================================
35/** describes all items of a DDE connection used in formulas.
36
37    <p>A DDE connection consists of the DDE service name, the DDE topic and a
38    list of DDE items which may contain results cached from the last update.</p>
39
40    <p>The formula that would need this information for example would contain
41    <code>=[1]!'R1C1'</code> or <code>=[2]!'Sheet1.A1'</code> where
42    <em>[1]</em> is an external link with DDE service name "excel" and the
43    topic "X:\PATH\[FILE.XLSX]Sheet1", and <em>[2]</em> contains service
44    "soffice" and topic "file:///X:/PATH/FILE.ODS". The service name is stored
45    in <member>DDELinkInfo::Service</member>, the topic is stored in
46    <member>DDELinkInfo::Topic</member>. Note that if the DDE item contains
47    single quotes they are escaped by doubling them, as usual, for example
48    <code>=[2]!'''Sheet name''.A1'</code> in a "soffice" service.</p>
49
50    @since OpenOffice 3.1
51 */
52struct DDELinkInfo
53{
54    //-------------------------------------------------------------------------
55    /** The DDE service name.
56     */
57    string Service;
58
59    //-------------------------------------------------------------------------
60    /** The DDE topic.
61     */
62    string Topic;
63
64    //-------------------------------------------------------------------------
65    /** A list of DDE items. Each item may contain its results from the last
66        update.
67     */
68    sequence< DDEItemInfo > Items;
69
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77