summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/SheetLink.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sheet/SheetLink.idl')
-rw-r--r--offapi/com/sun/star/sheet/SheetLink.idl109
1 files changed, 109 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/SheetLink.idl b/offapi/com/sun/star/sheet/SheetLink.idl
new file mode 100644
index 000000000000..b81b79ce19be
--- /dev/null
+++ b/offapi/com/sun/star/sheet/SheetLink.idl
@@ -0,0 +1,109 @@
+/*************************************************************************
+ *
+ * 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_SheetLink_idl__
+#define __com_sun_star_sheet_SheetLink_idl__
+
+#ifndef __com_sun_star_container_XNamed_idl__
+#include <com/sun/star/container/XNamed.idl>
+#endif
+
+#ifndef __com_sun_star_util_XRefreshable_idl__
+#include <com/sun/star/util/XRefreshable.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** represents a sheet link.
+
+ <p>A sheet link contains the source data of linked sheets, i.e. the
+ URL and sheet name of the external document.</p>
+
+ <p>To create a linked sheet, the sheet which will be used as linked
+ sheet has to exist already. The method
+ <member>XSheetLinkable::link</member> creates a <type>SheetLink</type>
+ object in the document's <type>SheetLinks</type> collection and links
+ the sheet to the specified external sheet.</p>
+ */
+published service SheetLink
+{
+ //-------------------------------------------------------------------------
+
+ /** provides access to the name of the linked document.
+
+ <p>This name is equal to the <const>Url</const> property.</p>
+ */
+ interface com::sun::star::container::XNamed;
+
+ //-------------------------------------------------------------------------
+
+ /** provides methods to reload the external data.
+ */
+ interface com::sun::star::util::XRefreshable;
+
+ //-------------------------------------------------------------------------
+
+//!published service PropertySet
+ /** provides access to the properties.
+ */
+ interface com::sun::star::beans::XPropertySet;
+
+ //=========================================================================
+
+ /** specifies the URL of the source document.
+ */
+ [property] string Url;
+
+ //-------------------------------------------------------------------------
+
+ /** specifies the name of the filter needed to load the source
+ document.
+ */
+ [property] string Filter;
+
+ //-------------------------------------------------------------------------
+
+ /** specifies the filter options needed to load the source document.
+ */
+ [property] string FilterOptions;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+