1 files changed, 98 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XExternalDocLink.idl b/offapi/com/sun/star/sheet/XExternalDocLink.idl
new file mode 100644
index 000000000000..80b249e7d520
--- /dev/null
+++ b/offapi/com/sun/star/sheet/XExternalDocLink.idl
@@ -0,0 +1,98 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_sheet_XExternalDocLink_idl__
+#define __com_sun_star_sheet_XExternalDocLink_idl__
+
+#include <com/sun/star/container/XEnumerationAccess.idl>
+#include <com/sun/star/container/XIndexAccess.idl>
+#include <com/sun/star/container/XNameAccess.idl>
+#include <com/sun/star/sheet/XExternalSheetCache.idl>
+
+module com {  module sun {  module star {  module sheet {
+
+//=============================================================================
+
+/** Primary interface for the <type scope="com::sun::star::sheet">ExternalDocLink</type> service.
+
+    @see com::sun::star::sheet::ExternalDocLink
+
+    @since OOo 3.1
+ */
+interface XExternalDocLink
+{
+    interface com::sun::star::container::XNameAccess;
+    interface com::sun::star::container::XIndexAccess;
+    interface com::sun::star::container::XEnumerationAccess;
+
+    //-------------------------------------------------------------------------
+
+    /** <p>This method adds a new sheet cache instance to the external document
+        link for a specified sheet name.  If a sheet cache instance already
+        exists for the specified name, then the existing instance is returned.</p>
+
+        <p>Note that a sheet name lookup is performed in a case-insensitive
+        fashion.</p>
+
+        @param aSheetName sheet name
+
+        @param DynamicCache specify whether or not the cache can grow when
+        non-cached regions are queried.  If <true/>, querying a non-cached
+        cell in this sheet cache will allow Calc to try to access the source
+        document to fetch the value in first access.  If <false/>, the source
+        document will not be accessed, and the non-cached regions are treated
+        as empty cells.
+
+        @return com::sun::star::sheet::XExternalSheetCache sheet cache instance
+     */
+    com::sun::star::sheet::XExternalSheetCache addSheetCache( [in] string aSheetName, [in] boolean DynamicCache );
+
+    //-------------------------------------------------------------------------
+
+    /** Index corresponding to the external document link.
+
+        <p>This index value corresponds with the external document
+        represented by an instance of
+        <type scope="com::sun::star::sheet">ExternalDocLink</type>.  This
+        value is stored within a formula token instance.</p>
+
+        <p>Each external document cache instance has a unique index value, and this
+        index value can be used to retrieve the corresponding external document cache
+        from the parent <type scope="com::sun::star::sheet">ExternalDocLinks</type> instance.</p>
+
+        @see com::sun::star::sheet::ExternalDocLinks
+        @see com::sun::star::sheet::FormulaToken
+        @see com::sun::star::sheet::ExternalReference
+     */
+    [attribute, readonly] long TokenIndex;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif