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