offapi/com/sun/star/sheet/ExternalReference.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: ExternalReference.idl,v $
  10  * $Revision: 1.1.2.4 $
  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
  31 #ifndef __com_sun_star_sheet_ExternalReference_idl__
  32 #define __com_sun_star_sheet_ExternalReference_idl__
  33
  34 module com {  module sun {  module star {  module sheet {
  35
  36 //=============================================================================
  37
  38 /** Data structure to store information about an external reference.  An
  39     external reference can be either a single cell reference, a cell range
  40     reference, or a named range.
  41
  42     @see FormulaMapGroupSpecialOffset::PUSH
  43
  44     @since OOo 3.1
  45  */
  46 struct ExternalReference
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** Index of an externally linked document.  Each externally-linked document
  51         has a unique index value.
  52
  53         <p>You can get the index value of an external document from the
  54         corresponding <type scope="com::sun::star::sheet">ExternalDocLink</type>
  55         instance through its attribute <type scope="com::sun::star::sheet::ExternalDocLink">TokenIndex</type>.</p>
  56
  57         @see com::sun::star::sheet::ExternalDocLink
  58         @see com::sun::star::sheet::ExternalDocLink::TokenIndex
  59      */
  60     long Index;
  61
  62 #if 0
  63     //-------------------------------------------------------------------------
  64
  65     /** Name of the sheet that the external reference points to.
  66
  67         <p>In case of a cell range reference that spans across multiple
  68         sheets, this is the name of the first sheet in that range.</p>
  69
  70         <p>Note that an external range name ignores this value at the moment,
  71         but <i>it may make use of this data in the future when Calc supports a
  72         sheet-specific range name.</i></p>
  73      */
  74     string SheetName;
  75 #endif
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** Reference data.
  80
  81         <p>This can store either <type>SingleReference</type> for a single
  82         cell reference, <type>ComplexReference</type> for a cell range
  83         reference, or simply a <type>string</type> for a defined name.</p>
  84
  85         <p>The <member>SingleReference::Sheet</member> member shall contain
  86         the index of the external sheet cache containing the values of the
  87         externally referenced cells.</p>
  88
  89         @see com::sun::star::sheet::SingleReference
  90         @see com::sun::star::sheet::ComplexReference
  91      */
  92     any Reference;
  93 };
  94
  95 //=============================================================================
  96
  97 }; }; }; };
  98
  99 #endif