offapi/com/sun/star/sheet/XDDELinks.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XDDELinks_idl__
  21 #define __com_sun_star_sheet_XDDELinks_idl__
  22
  23 #include <com/sun/star/container/XNameAccess.idl>
  24 #include <com/sun/star/sheet/XDDELink.idl>
  25 #include <com/sun/star/sheet/DDELinkMode.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** provides a method to add a DDE link to a spreadsheet.
  32
  33     @see com::sun::star::sheet::DDELinks
  34
  35     @since OOo 3.0
  36  */
  37 published interface XDDELinks: com::sun::star::container::XNameAccess
  38 {
  39
  40     /** adds a DDE link to the spreadsheet without updating it.
  41
  42         <p>If a DDE link with the specified parameters already exists, the
  43         existing DDE link will be returned. Otherwise a new DDE link will be
  44         created.</p>
  45
  46         @param aApplication
  47             the DDE server application from which data are requested.
  48
  49         @param aTopic
  50             the DDE topic from which data are requested.
  51
  52         @param aItem
  53             the DDE item from which data are requested.
  54
  55         @param nMode
  56             the DDE link mode.
  57
  58         @returns
  59             the DDE link.
  60      */
  61     com::sun::star::sheet::XDDELink addDDELink(
  62             [in] string aApplication,
  63             [in] string aTopic,
  64             [in] string aItem,
  65             [in] com::sun::star::sheet::DDELinkMode nMode );
  66
  67 };
  68
  69
  70 }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */