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