xref: /aoo41x/main/offapi/com/sun/star/sheet/XDDELinks.idl (revision fbef625e)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XDDELinks_idl__
25cdf0e10cSrcweir#define __com_sun_star_sheet_XDDELinks_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameAccess_idl__
28cdf0e10cSrcweir#include <com/sun/star/container/XNameAccess.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XDDELink_idl__
32cdf0e10cSrcweir#include <com/sun/star/sheet/XDDELink.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
35cdf0e10cSrcweir#ifndef __com_sun_star_sheet_DDELinkMode_idl__
36cdf0e10cSrcweir#include <com/sun/star/sheet/DDELinkMode.idl>
37cdf0e10cSrcweir#endif
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweirmodule com {  module sun {  module star {  module sheet {
42cdf0e10cSrcweir
43cdf0e10cSrcweir//=============================================================================
44cdf0e10cSrcweir
45cdf0e10cSrcweir/** provides a method to add a DDE link to a spreadsheet.
46cdf0e10cSrcweir
47cdf0e10cSrcweir    @see com::sun::star::sheet::DDELinks
48cdf0e10cSrcweir
49*fbef625eSJürgen Schmidt    @since OpenOffice 3.0
50cdf0e10cSrcweir */
51cdf0e10cSrcweirpublished interface XDDELinks: com::sun::star::container::XNameAccess
52cdf0e10cSrcweir{
53cdf0e10cSrcweir    //-------------------------------------------------------------------------
54cdf0e10cSrcweir
55cdf0e10cSrcweir    /** adds a DDE link to the spreadsheet without updating it.
56cdf0e10cSrcweir
57cdf0e10cSrcweir        <p>If a DDE link with the specified parameters already exists, the
58cdf0e10cSrcweir        existing DDE link will be returned. Otherwise a new DDE link will be
59cdf0e10cSrcweir        created.</p>
60cdf0e10cSrcweir
61cdf0e10cSrcweir        @param aApplication
62cdf0e10cSrcweir            the DDE server application from which data are requested.
63cdf0e10cSrcweir
64cdf0e10cSrcweir        @param aTopic
65cdf0e10cSrcweir            the DDE topic from which data are requested.
66cdf0e10cSrcweir
67cdf0e10cSrcweir        @param aItem
68cdf0e10cSrcweir            the DDE item from which data are requested.
69cdf0e10cSrcweir
70cdf0e10cSrcweir        @param nMode
71cdf0e10cSrcweir            the DDE link mode.
72cdf0e10cSrcweir
73cdf0e10cSrcweir        @returns
74cdf0e10cSrcweir            the DDE link.
75cdf0e10cSrcweir     */
76cdf0e10cSrcweir    com::sun::star::sheet::XDDELink addDDELink(
77cdf0e10cSrcweir            [in] string aApplication,
78cdf0e10cSrcweir            [in] string aTopic,
79cdf0e10cSrcweir            [in] string aItem,
80cdf0e10cSrcweir            [in] com::sun::star::sheet::DDELinkMode nMode );
81cdf0e10cSrcweir
82cdf0e10cSrcweir};
83cdf0e10cSrcweir
84cdf0e10cSrcweir//=============================================================================
85cdf0e10cSrcweir
86cdf0e10cSrcweir}; }; }; };
87cdf0e10cSrcweir
88cdf0e10cSrcweir#endif
89