summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/document/XScriptInvocationContext.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/document/XScriptInvocationContext.idl')
-rw-r--r--offapi/com/sun/star/document/XScriptInvocationContext.idl76
1 files changed, 76 insertions, 0 deletions
diff --git a/offapi/com/sun/star/document/XScriptInvocationContext.idl b/offapi/com/sun/star/document/XScriptInvocationContext.idl
new file mode 100644
index 000000000000..43575c885b5c
--- /dev/null
+++ b/offapi/com/sun/star/document/XScriptInvocationContext.idl
@@ -0,0 +1,76 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: XScriptInvocationContext.idl,v $
+ * $Revision: 1.3 $
+ *
+ * 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_document_XScriptInvocationContext_idl__
+#define __com_sun_star_document_XScriptInvocationContext_idl__
+
+
+#ifndef __com_sun_star_document_XEmbeddedScripts_idl__
+#include <com/sun/star/document/XEmbeddedScripts.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module document {
+
+//=============================================================================
+
+/** indicates support for executing scripts contained in a, possibly foreign, document.
+
+ <p>If the component implementing it is a document, which supports embedding scripts into
+ itself, then <member>ScriptContainer</member> refers to the document itself. Implementing this
+ interface is unnecessary then, instead the document should simply implement <type>XEmbeddedScripts</type> directly.</p>
+
+ <p>If the interface is implemented by a document which does not itself support embedding
+ scripts into it, but which is associated unambiguously with a document which does,
+ then this other document is denoted by <member>ScriptContainer</member>.</p>
+
+ <p>If the interface is implemented by a controller, then <member>ScriptContainer</member>
+ refers to the document which supports embedding scripts, and which is unambiguosly
+ associated with the controller. This must not necessarily be the model returned by
+ <member scope="com::sun::star::frame">XController::getModel</member>.</p>
+
+ @since OOo 2.4
+ */
+interface XScriptInvocationContext
+{
+ /** denotes the document which contains the scripts which are to be invoked from
+ the component implementing the XScriptInvocationContext inteface.
+ */
+ [attribute, readonly] XEmbeddedScripts ScriptContainer;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif