offapi/com/sun/star/sheet/XExternalDocLink.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 module com {  module sun {  module star {  module sheet {
  21
  22
  23 /** Primary interface for the com::sun::star::sheet::ExternalDocLink service.
  24
  25     @see com::sun::star::sheet::ExternalDocLink
  26
  27     @since OOo 3.1
  28  */
  29 interface XExternalDocLink
  30 {
  31     interface com::sun::star::container::XNameAccess;
  32     interface com::sun::star::container::XIndexAccess;
  33     interface com::sun::star::container::XEnumerationAccess;
  34
  35
  36     /** <p>This method adds a new sheet cache instance to the external document
  37         link for a specified sheet name.  If a sheet cache instance already
  38         exists for the specified name, then the existing instance is returned.</p>
  39
  40         <p>Note that a sheet name lookup is performed in a case-insensitive
  41         fashion.</p>
  42
  43         @param aSheetName sheet name
  44
  45         @param DynamicCache specify whether or not the cache can grow when
  46         non-cached regions are queried.  If `TRUE`, querying a non-cached
  47         cell in this sheet cache will allow Calc to try to access the source
  48         document to fetch the value in first access.  If `FALSE`, the source
  49         document will not be accessed, and the non-cached regions are treated
  50         as empty cells.
  51
  52         @return com::sun::star::sheet::XExternalSheetCache sheet cache instance
  53      */
  54     com::sun::star::sheet::XExternalSheetCache addSheetCache( [in] string aSheetName, [in] boolean DynamicCache );
  55
  56
  57     /** Index corresponding to the external document link.
  58
  59         <p>This index value corresponds with the external document
  60         represented by an instance of
  61         com::sun::star::sheet::ExternalDocLink.  This
  62         value is stored within a formula token instance.</p>
  63
  64         <p>Each external document cache instance has a unique index value, and this
  65         index value can be used to retrieve the corresponding external document cache
  66         from the parent com::sun::star::sheet::ExternalDocLinks instance.</p>
  67
  68         @see com::sun::star::sheet::ExternalDocLinks
  69         @see com::sun::star::sheet::FormulaToken
  70         @see com::sun::star::sheet::ExternalReference
  71      */
  72     [attribute, readonly] long TokenIndex;
  73 };
  74
  75
  76 }; }; }; };
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */