udkapi/com/sun/star/script/XEngine.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 #ifndef __com_sun_star_script_XEngine_idl__
  20 #define __com_sun_star_script_XEngine_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/script/XLibraryAccess.idl>
  25
  26 #include <com/sun/star/script/XEngineListener.idl>
  27
  28
  29
  30 module com {  module sun {  module star {  module script {
  31
  32 /** makes it possible to control a scripting engine.
  33     @deprecated
  34  */
  35 published interface XEngine: com::sun::star::uno::XInterface
  36 {
  37     /** sets an interface to an object as a scripting root.
  38
  39         <p>If the root object implements the XInvocation interface,
  40         then the engine uses this interface to set/get properties and
  41         call methods.
  42         </p>
  43      */
  44     void setRoot( [in] com::sun::star::uno::XInterface xRoot );
  45
  46     /** gets an interface to the object which is the scripting root.
  47      */
  48     com::sun::star::uno::XInterface getRoot();
  49
  50     /** sets an access object to get external functions.
  51      */
  52     void setLibraryAccess( [in] com::sun::star::script::XLibraryAccess Library );
  53
  54     /** compiles a script module in the scope of the root object.
  55      */
  56     boolean compile( [in] string ModuleName,
  57              [in] string Script,
  58              [in] boolean CreateDebugInfo );
  59
  60     /** runs a script specified by a string.
  61
  62         <p>The arguments given in <var>aArgs</var> can be ignored by
  63         the engine.  The Script is executed synchronously.</p>
  64      */
  65     any run( [in] string aScript,
  66              [in] com::sun::star::uno::XInterface xThis,
  67              [in] sequence<any> aArgs );
  68
  69     /** runs the script specified by a string and makes callbacks.
  70
  71         <p>The arguments given in <var>aArgs</var> can be ignored by
  72         the engine.  The script is executed asynchronously.
  73
  74         </p>
  75      */
  76     void runAsync( [in] string acript,
  77              [in] com::sun::star::uno::XInterface xThis,
  78              [in] sequence<any> args,
  79              [in] com::sun::star::script::XEngineListener xCallback );
  80
  81     /** terminates the execution of the running script.
  82
  83         <p>The waiting queue is cleared too.</p>
  84      */
  85     void cancel();
  86
  87     /** adds an engine listener.
  88
  89        <p>It is suggested to allow multiple registration of the same listener,
  90         thus for each time a listener is added, it has to be removed.
  91      */
  92     void addEngineListener( [in] com::sun::star::script::XEngineListener Listener );
  93
  94     /** removes an engine listener.
  95
  96        <p>It is suggested to allow multiple registration of the same listener,
  97         thus for each time a listener is added, it has to be removed.
  98      */
  99     void removeEngineListener( [in] com::sun::star::script::XEngineListener Listener );
 100
 101 };
 102
 103
 104 }; }; }; };
 105
 106 #endif
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */