offapi/com/sun/star/document/XScriptInvocationContext.idl

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