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