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