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

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