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