offapi/com/sun/star/sheet/DDELinkInfo.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: DDELinkInfo.idl,v $
  10  * $Revision: 1.1.2.1 $
  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 #ifndef __com_sun_star_sheet_DDELinkInfo_idl__
  31 #define __com_sun_star_sheet_DDELinkInfo_idl__
  32
  33 #ifndef __com_sun_star_sheet_DDEItemInfo_idl__
  34 #include <com/sun/star/sheet/DDEItemInfo.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module sheet {
  40
  41 //=============================================================================
  42 /** describes all items of a DDE connection used in formulas.
  43
  44     <p>A DDE connection consists of the DDE service name, the DDE topic and a
  45     list of DDE items which may contain results cached from the last update.</p>
  46
  47     <p>The formula that would need this information for example would contain
  48     <code>=[1]!'R1C1'</code> or <code>=[2]!'Sheet1.A1'</code> where
  49     <em>[1]</em> is an external link with DDE service name "excel" and the
  50     topic "X:\PATH\[FILE.XLSX]Sheet1", and <em>[2]</em> contains service
  51     "soffice" and topic "file:///X:/PATH/FILE.ODS". The service name is stored
  52     in <member>DDELinkInfo::Service</member>, the topic is stored in
  53     <member>DDELinkInfo::Topic</member>. Note that if the DDE item contains
  54     single quotes they are escaped by doubling them, as usual, for example
  55     <code>=[2]!'''Sheet name''.A1'</code> in a "soffice" service.</p>
  56
  57     @since OOo3.1
  58  */
  59 struct DDELinkInfo
  60 {
  61     //-------------------------------------------------------------------------
  62     /** The DDE service name.
  63      */
  64     string Service;
  65
  66     //-------------------------------------------------------------------------
  67     /** The DDE topic.
  68      */
  69     string Topic;
  70
  71     //-------------------------------------------------------------------------
  72     /** A list of DDE items. Each item may contain its results from the last
  73         update.
  74      */
  75     sequence< DDEItemInfo > Items;
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif