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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_document_XScriptInvocationContext_idl__
  21 #define __com_sun_star_document_XScriptInvocationContext_idl__
  22
  23
  24 #include <com/sun/star/document/XEmbeddedScripts.idl>
  25
  26
  27 module com { module sun { module star { module document {
  28
  29
  30 /** indicates support for executing scripts contained in a, possibly foreign, document.
  31
  32     <p>If the component implementing it is a document, which supports embedding scripts into
  33     itself, then #ScriptContainer refers to the document itself. Implementing this
  34     interface is unnecessary then, instead the document should simply implement XEmbeddedScripts directly.</p>
  35
  36     <p>If the interface is implemented by a document which does not itself support embedding
  37     scripts into it, but which  is associated unambiguously with a document which does,
  38     then this other document is denoted by #ScriptContainer.</p>
  39
  40     <p>If the interface is implemented by a controller, then #ScriptContainer
  41     refers to the document which supports embedding scripts, and which is unambiguously
  42     associated with the controller. This must not necessarily be the model returned by
  43     com::sun::star::frame::XController::getModel().</p>
  44
  45     @since OOo 2.4
  46  */
  47 interface XScriptInvocationContext
  48 {
  49     /** denotes the document which contains the scripts which are to be invoked from
  50     the component implementing the XScriptInvocationContext interface.
  51     */
  52     [attribute, readonly] XEmbeddedScripts ScriptContainer;
  53 };
  54
  55
  56 }; }; }; };
  57
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */