offapi/com/sun/star/sheet/ExternalLinkInfo.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: ExternalLinkInfo.idl,v $
  10  * $Revision: 1.1.2.2 $
  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_ExternalLinkInfo_idl__
  31 #define __com_sun_star_sheet_ExternalLinkInfo_idl__
  32
  33 #ifndef __com_sun_star_sheet_ExternalLinkType_idl__
  34 #include <com/sun/star/sheet/ExternalLinkType.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module sheet {
  40
  41 //=============================================================================
  42 /** describes an external link in a formula.
  43
  44     @since OOo3.1
  45  */
  46 struct ExternalLinkInfo
  47 {
  48     //-------------------------------------------------------------------------
  49     /** Link type, one of <type>ExternalLinkType</type> constants.
  50      */
  51     long Type;
  52
  53     //-------------------------------------------------------------------------
  54     /** Location of this link type.
  55
  56         <p>Modes used:
  57
  58         <ol>
  59         <li>If <member>Type</member> is <const>ExternalLinkType::EXTERNAL
  60         </const>, this member shall contain a <atom>string</atom> with the
  61         <em>URI</em> of a document. The formula that would need this
  62         information for example would contain <code>=[1]Sheet1!A1</code> or
  63         <code>='[1]Sheet name'!A1</code> where <em>[1]</em> does resolve to
  64         the URI contained in the member <member>Data</member>. Note that the
  65         quotes cover both, the document name and the sheet name.</li>
  66
  67         <li>If <member>Type</member> is <const>ExternalLinkType::DDE</const>,
  68         this member shall contain a <type>DDELinkInfo</type> describing
  69         service name, topic, and all known items of a DDE link.</li>
  70         </ol></p>
  71      */
  72     any Data;
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif