LibreOffice LibreOffice 25.8 SDK API Reference

XEngine.idl
Go to the documentation of this file.
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
21
22module com { module sun { module star { module script {
23
27published interface XEngine: com::sun::star::uno::XInterface
28{
36 void setRoot( [in] com::sun::star::uno::XInterface xRoot );
37
40 com::sun::star::uno::XInterface getRoot();
41
44 void setLibraryAccess( [in] com::sun::star::script::XLibraryAccess Library );
45
48 boolean compile( [in] string ModuleName,
49 [in] string Script,
50 [in] boolean CreateDebugInfo );
51
57 any run( [in] string aScript,
58 [in] com::sun::star::uno::XInterface xThis,
59 [in] sequence<any> aArgs );
60
68 void runAsync( [in] string acript,
69 [in] com::sun::star::uno::XInterface xThis,
70 [in] sequence<any> args,
71 [in] com::sun::star::script::XEngineListener xCallback );
72
77 void cancel();
78
84 void addEngineListener( [in] com::sun::star::script::XEngineListener Listener );
85
91 void removeEngineListener( [in] com::sun::star::script::XEngineListener Listener );
92
93};
94
95
96}; }; }; };
97
98/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::script::XEngineListener
makes it possible to receive events from a scripting engine.
Definition: XEngineListener.idl:28
com::sun::star::script::XEngine
makes it possible to control a scripting engine.
Definition: XEngine.idl:28
com::sun::star::script::XEngine::cancel
void cancel()
terminates the execution of the running script.
com::sun::star::script::XEngine::addEngineListener
void addEngineListener([in] com::sun::star::script::XEngineListener Listener)
adds an engine listener.
com::sun::star::script::XEngine::runAsync
void runAsync([in] string acript, [in] com::sun::star::uno::XInterface xThis, [in] sequence< any > args, [in] com::sun::star::script::XEngineListener xCallback)
runs the script specified by a string and makes callbacks.
com::sun::star::script::XEngine::removeEngineListener
void removeEngineListener([in] com::sun::star::script::XEngineListener Listener)
removes an engine listener.
com::sun::star::script::XEngine::compile
boolean compile([in] string ModuleName, [in] string Script, [in] boolean CreateDebugInfo)
compiles a script module in the scope of the root object.
com::sun::star::script::XEngine::setRoot
void setRoot([in] com::sun::star::uno::XInterface xRoot)
sets an interface to an object as a scripting root.
com::sun::star::script::XEngine::run
any run([in] string aScript, [in] com::sun::star::uno::XInterface xThis, [in] sequence< any > aArgs)
runs a script specified by a string.
com::sun::star::script::XEngine::getRoot
com::sun::star::uno::XInterface getRoot()
gets an interface to the object which is the scripting root.
com::sun::star::script::XEngine::setLibraryAccess
void setLibraryAccess([in] com::sun::star::script::XLibraryAccess Library)
sets an access object to get external functions.
com::sun::star::script::XLibraryAccess
provides access to additional scripting code.
Definition: XLibraryAccess.idl:32
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20