Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: script ::

interface XEngine

Base Interface
com::sun::star::uno::XInterface

Description
makes it possible to control a scripting engine.


Known Services which Export this Interface

com::sun::star::script::Engine service that any scripting engine must implement.
com::sun::star::script::Engine service that any scripting engine must implement.

Methods' Summary

setRoot sets an interface to an object as a scripting root.
getRoot gets an interface to the object which is the scripting root.
setLibraryAccess sets an access object to get external functions.
compile compiles a script module in the scope of the root object.
run runs a script specified by a string.
runAsync runs the script specified by a string and makes callbacks.
cancel terminates the execution of the running script.
addEngineListener adds an engine listener.
removeEngineListener removes an engine listener.

Methods' Details

setRoot
 
void
setRoot(
[ in ] com::sun::star::uno::XInterface xRoot );

Description
sets an interface to an object as a scripting root.

If the root object implements the XInvocation interface, then the engine uses this interface to set/get properties and call methods.

getRoot
 
com::sun::star::uno::XInterface
getRoot();
Description
gets an interface to the object which is the scripting root.
setLibraryAccess
 
void
setLibraryAccess(
[ in ] com::sun::star::script::XLibraryAccess Library );

Description
sets an access object to get external functions.
compile
 
boolean
compile(
[ in ] string ModuleName,
[ in ] string Script,
[ in ] boolean CreateDebugInfo );

Description
compiles a script module in the scope of the root object.
run
 
any
run(
[ in ] string aScript,
[ in ] com::sun::star::uno::XInterface xThis,
[ in ] sequence< any > aArgs );

Description
runs a script specified by a string.

The arguments given in aArgs can be ignored by the engine. The Script is executed synchronously.

runAsync
 
void
runAsync(
[ in ] string acript,
[ in ] com::sun::star::uno::XInterface xThis,
[ in ] sequence< any > args,
[ in ] com::sun::star::script::XEngineListener xCallback );

Description
runs the script specified by a string and makes callbacks.

The arguments given in aArgs can be ignored by the engine. The script is executed asynchronously.

cancel
 
void
cancel();
Description
terminates the execution of the running script.

The waiting queue (see ) is cleared too.

addEngineListener
 
void
addEngineListener(
[ in ] com::sun::star::script::XEngineListener Listener );

Description
adds an engine listener.
removeEngineListener
 
void
removeEngineListener(
[ in ] com::sun::star::script::XEngineListener Listener );

Description
removes an engine listener.

Top of Page