offapi/com/sun/star/sheet/ExternalLinkInfo.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_ExternalLinkInfo_idl__
  20 #define __com_sun_star_sheet_ExternalLinkInfo_idl__
  21
  22 #include <com/sun/star/sheet/ExternalLinkType.idl>
  23
  24
  25 module com {  module sun {  module star {  module sheet {
  26
  27 /** describes an external link in a formula.
  28
  29     @since OOo 3.1
  30  */
  31 struct ExternalLinkInfo
  32 {
  33     /** Link type, one of ExternalLinkType constants.
  34      */
  35     long Type;
  36
  37     /** Location of this link type.
  38
  39         <p>Modes used:
  40
  41         <ol>
  42         <li>If #Type is ExternalLinkType::EXTERNAL,
  43         this member shall contain a `string` with the
  44         <em>URI</em> of a document. The formula that would need this
  45         information for example would contain <code>=[1]Sheet1!A1</code> or
  46         <code>='[1]Sheet name'!A1</code> where <em>[1]</em> does resolve to
  47         the URI contained in the member #Data. Note that the
  48         quotes cover both, the document name and the sheet name.</li>
  49
  50         <li>If #Type is ExternalLinkType::DDE,
  51         this member shall contain a DDELinkInfo describing
  52         service name, topic, and all known items of a DDE link.</li>
  53         </ol></p>
  54      */
  55     any Data;
  56
  57 };
  58
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */