summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/XDDELinks.idl
blob: 8bfdb9663ee2065e7906f17b4ae905ebbe102ade (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_sheet_XDDELinks_idl__
#define __com_sun_star_sheet_XDDELinks_idl__

#include <com/sun/star/container/XNameAccess.idl>
#include <com/sun/star/sheet/XDDELink.idl>
#include <com/sun/star/sheet/DDELinkMode.idl>


module com {  module sun {  module star {  module sheet {


/** provides a method to add a DDE link to a spreadsheet.

    @see com::sun::star::sheet::DDELinks

    @since OOo 3.0
 */
published interface XDDELinks: com::sun::star::container::XNameAccess
{

    /** adds a DDE link to the spreadsheet without updating it.

        <p>If a DDE link with the specified parameters already exists, the
        existing DDE link will be returned. Otherwise a new DDE link will be
        created.</p>

        @param aApplication
            the DDE server application from which data are requested.

        @param aTopic
            the DDE topic from which data are requested.

        @param aItem
            the DDE item from which data are requested.

        @param nMode
            the DDE link mode.

        @returns
            the DDE link.
     */
    com::sun::star::sheet::XDDELink addDDELink(
            [in] string aApplication,
            [in] string aTopic,
            [in] string aItem,
            [in] com::sun::star::sheet::DDELinkMode nMode );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */