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