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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XDDELinks_idl__
  29 #define __com_sun_star_sheet_XDDELinks_idl__
  30
  31 #ifndef __com_sun_star_container_XNameAccess_idl__
  32 #include <com/sun/star/container/XNameAccess.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_sheet_XDDELink_idl__
  36 #include <com/sun/star/sheet/XDDELink.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_sheet_DDELinkMode_idl__
  40 #include <com/sun/star/sheet/DDELinkMode.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module sheet {
  46
  47 //=============================================================================
  48
  49 /** provides a method to add a DDE link to a spreadsheet.
  50
  51     @see com::sun::star::sheet::DDELinks
  52
  53     @since OOo 3.0
  54  */
  55 published interface XDDELinks: com::sun::star::container::XNameAccess
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** adds a DDE link to the spreadsheet without updating it.
  60
  61         <p>If a DDE link with the specified parameters already exists, the
  62         existing DDE link will be returned. Otherwise a new DDE link will be
  63         created.</p>
  64
  65         @param aApplication
  66             the DDE server application from which data are requested.
  67
  68         @param aTopic
  69             the DDE topic from which data are requested.
  70
  71         @param aItem
  72             the DDE item from which data are requested.
  73
  74         @param nMode
  75             the DDE link mode.
  76
  77         @returns
  78             the DDE link.
  79      */
  80     com::sun::star::sheet::XDDELink addDDELink(
  81             [in] string aApplication,
  82             [in] string aTopic,
  83             [in] string aItem,
  84             [in] com::sun::star::sheet::DDELinkMode nMode );
  85
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif