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