xref: /aoo42x/main/offapi/com/sun/star/sheet/XDDELinks.idl (revision fbef625e)
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_XDDELinks_idl__
25#define __com_sun_star_sheet_XDDELinks_idl__
26
27#ifndef __com_sun_star_container_XNameAccess_idl__
28#include <com/sun/star/container/XNameAccess.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_XDDELink_idl__
32#include <com/sun/star/sheet/XDDELink.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_DDELinkMode_idl__
36#include <com/sun/star/sheet/DDELinkMode.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** provides a method to add a DDE link to a spreadsheet.
46
47    @see com::sun::star::sheet::DDELinks
48
49    @since OpenOffice 3.0
50 */
51published interface XDDELinks: com::sun::star::container::XNameAccess
52{
53    //-------------------------------------------------------------------------
54
55    /** adds a DDE link to the spreadsheet without updating it.
56
57        <p>If a DDE link with the specified parameters already exists, the
58        existing DDE link will be returned. Otherwise a new DDE link will be
59        created.</p>
60
61        @param aApplication
62            the DDE server application from which data are requested.
63
64        @param aTopic
65            the DDE topic from which data are requested.
66
67        @param aItem
68            the DDE item from which data are requested.
69
70        @param nMode
71            the DDE link mode.
72
73        @returns
74            the DDE link.
75     */
76    com::sun::star::sheet::XDDELink addDDELink(
77            [in] string aApplication,
78            [in] string aTopic,
79            [in] string aItem,
80            [in] com::sun::star::sheet::DDELinkMode nMode );
81
82};
83
84//=============================================================================
85
86}; }; }; };
87
88#endif
89