1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XExternalDocLink_idl__
25#define __com_sun_star_sheet_XExternalDocLink_idl__
26
27#include <com/sun/star/container/XEnumerationAccess.idl>
28#include <com/sun/star/container/XIndexAccess.idl>
29#include <com/sun/star/container/XNameAccess.idl>
30#include <com/sun/star/sheet/XExternalSheetCache.idl>
31
32module com {  module sun {  module star {  module sheet {
33
34//=============================================================================
35
36/** Primary interface for the <type scope="com::sun::star::sheet">ExternalDocLink</type> service.
37
38    @see com::sun::star::sheet::ExternalDocLink
39
40    @since OOo 3.1
41 */
42interface XExternalDocLink
43{
44    interface com::sun::star::container::XNameAccess;
45    interface com::sun::star::container::XIndexAccess;
46    interface com::sun::star::container::XEnumerationAccess;
47
48    //-------------------------------------------------------------------------
49
50    /** <p>This method adds a new sheet cache instance to the external document
51        link for a specified sheet name.  If a sheet cache instance already
52        exists for the specified name, then the existing instance is returned.</p>
53
54        <p>Note that a sheet name lookup is performed in a case-insensitive
55        fashion.</p>
56
57        @param aSheetName sheet name
58
59        @param DynamicCache specify whether or not the cache can grow when
60        non-cached regions are queried.  If <true/>, querying a non-cached
61        cell in this sheet cache will allow Calc to try to access the source
62        document to fetch the value in first access.  If <false/>, the source
63        document will not be accessed, and the non-cached regions are treated
64        as empty cells.
65
66        @return com::sun::star::sheet::XExternalSheetCache sheet cache instance
67     */
68    com::sun::star::sheet::XExternalSheetCache addSheetCache( [in] string aSheetName, [in] boolean DynamicCache );
69
70    //-------------------------------------------------------------------------
71
72    /** Index corresponding to the external document link.
73
74        <p>This index value corresponds with the external document
75        represented by an instance of
76        <type scope="com::sun::star::sheet">ExternalDocLink</type>.  This
77        value is stored within a formula token instance.</p>
78
79        <p>Each external document cache instance has a unique index value, and this
80        index value can be used to retrieve the corresponding external document cache
81        from the parent <type scope="com::sun::star::sheet">ExternalDocLinks</type> instance.</p>
82
83        @see com::sun::star::sheet::ExternalDocLinks
84        @see com::sun::star::sheet::FormulaToken
85        @see com::sun::star::sheet::ExternalReference
86     */
87    [attribute, readonly] long TokenIndex;
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95