1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_document_XScriptInvocationContext_idl__
29#define __com_sun_star_document_XScriptInvocationContext_idl__
30
31
32#ifndef __com_sun_star_document_XEmbeddedScripts_idl__
33#include <com/sun/star/document/XEmbeddedScripts.idl>
34#endif
35
36//=============================================================================
37
38module com { module sun { module star { module document {
39
40//=============================================================================
41
42/** indicates support for executing scripts contained in a, possibly foreign, document.
43
44    <p>If the component implementing it is a document, which supports embedding scripts into
45    itself, then <member>ScriptContainer</member> refers to the document itself. Implementing this
46    interface is unnecessary then, instead the document should simply implement <type>XEmbeddedScripts</type> directly.</p>
47
48    <p>If the interface is implemented by a document which does not itself support embedding
49    scripts into it, but which  is associated unambiguously with a document which does,
50    then this other document is denoted by <member>ScriptContainer</member>.</p>
51
52    <p>If the interface is implemented by a controller, then <member>ScriptContainer</member>
53    refers to the document which supports embedding scripts, and which is unambiguosly
54    associated with the controller. This must not necessarily be the model returned by
55    <member scope="com::sun::star::frame">XController::getModel</member>.</p>
56
57    @since OOo 2.4
58 */
59interface XScriptInvocationContext
60{
61    /** denotes the document which contains the scripts which are to be invoked from
62    the component implementing the XScriptInvocationContext inteface.
63    */
64    [attribute, readonly] XEmbeddedScripts ScriptContainer;
65};
66
67//=============================================================================
68
69}; }; }; };
70
71//=============================================================================
72
73#endif
74