1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XExternalDocLink_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_sheet_XExternalDocLink_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#include <com/sun/star/container/XEnumerationAccess.idl> 32*cdf0e10cSrcweir#include <com/sun/star/container/XIndexAccess.idl> 33*cdf0e10cSrcweir#include <com/sun/star/container/XNameAccess.idl> 34*cdf0e10cSrcweir#include <com/sun/star/sheet/XExternalSheetCache.idl> 35*cdf0e10cSrcweir 36*cdf0e10cSrcweirmodule com { module sun { module star { module sheet { 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir//============================================================================= 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir/** Primary interface for the <type scope="com::sun::star::sheet">ExternalDocLink</type> service. 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir @see com::sun::star::sheet::ExternalDocLink 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir @since OOo 3.1 45*cdf0e10cSrcweir */ 46*cdf0e10cSrcweirinterface XExternalDocLink 47*cdf0e10cSrcweir{ 48*cdf0e10cSrcweir interface com::sun::star::container::XNameAccess; 49*cdf0e10cSrcweir interface com::sun::star::container::XIndexAccess; 50*cdf0e10cSrcweir interface com::sun::star::container::XEnumerationAccess; 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir //------------------------------------------------------------------------- 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir /** <p>This method adds a new sheet cache instance to the external document 55*cdf0e10cSrcweir link for a specified sheet name. If a sheet cache instance already 56*cdf0e10cSrcweir exists for the specified name, then the existing instance is returned.</p> 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir <p>Note that a sheet name lookup is performed in a case-insensitive 59*cdf0e10cSrcweir fashion.</p> 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir @param aSheetName sheet name 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir @param DynamicCache specify whether or not the cache can grow when 64*cdf0e10cSrcweir non-cached regions are queried. If <true/>, querying a non-cached 65*cdf0e10cSrcweir cell in this sheet cache will allow Calc to try to access the source 66*cdf0e10cSrcweir document to fetch the value in first access. If <false/>, the source 67*cdf0e10cSrcweir document will not be accessed, and the non-cached regions are treated 68*cdf0e10cSrcweir as empty cells. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @return com::sun::star::sheet::XExternalSheetCache sheet cache instance 71*cdf0e10cSrcweir */ 72*cdf0e10cSrcweir com::sun::star::sheet::XExternalSheetCache addSheetCache( [in] string aSheetName, [in] boolean DynamicCache ); 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir //------------------------------------------------------------------------- 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir /** Index corresponding to the external document link. 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir <p>This index value corresponds with the external document 79*cdf0e10cSrcweir represented by an instance of 80*cdf0e10cSrcweir <type scope="com::sun::star::sheet">ExternalDocLink</type>. This 81*cdf0e10cSrcweir value is stored within a formula token instance.</p> 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir <p>Each external document cache instance has a unique index value, and this 84*cdf0e10cSrcweir index value can be used to retrieve the corresponding external document cache 85*cdf0e10cSrcweir from the parent <type scope="com::sun::star::sheet">ExternalDocLinks</type> instance.</p> 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir @see com::sun::star::sheet::ExternalDocLinks 88*cdf0e10cSrcweir @see com::sun::star::sheet::FormulaToken 89*cdf0e10cSrcweir @see com::sun::star::sheet::ExternalReference 90*cdf0e10cSrcweir */ 91*cdf0e10cSrcweir [attribute, readonly] long TokenIndex; 92*cdf0e10cSrcweir}; 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir//============================================================================= 95*cdf0e10cSrcweir 96*cdf0e10cSrcweir}; }; }; }; 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir#endif 99