<html> <head> <title>Interface XEngine</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XEngine-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">script</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">deprecated </td> <td width="50%" class="title">interface XEngine</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Description</b></dt> <dd>makes it possible to control a scripting engine. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#setRoot">setRoot</a></td> <td class="imsum_right">sets an interface to an object as a scripting root. </td> </tr> <tr> <td class="imsum_left"><a href="#getRoot">getRoot</a></td> <td class="imsum_right">gets an interface to the object which is the scripting root. </td> </tr> <tr> <td class="imsum_left"><a href="#setLibraryAccess">setLibraryAccess</a></td> <td class="imsum_right">sets an access object to get external functions. </td> </tr> <tr> <td class="imsum_left"><a href="#compile">compile</a></td> <td class="imsum_right">compiles a script module in the scope of the root object. </td> </tr> <tr> <td class="imsum_left"><a href="#run">run</a></td> <td class="imsum_right">runs a script specified by a string. </td> </tr> <tr> <td class="imsum_left"><a href="#runAsync">runAsync</a></td> <td class="imsum_right">runs the script specified by a string and makes callbacks. </td> </tr> <tr> <td class="imsum_left"><a href="#cancel">cancel</a></td> <td class="imsum_right">terminates the execution of the running script. </td> </tr> <tr> <td class="imsum_left"><a href="#addEngineListener">addEngineListener</a></td> <td class="imsum_right">adds an engine listener. </td> </tr> <tr> <td class="imsum_left"><a href="#removeEngineListener">removeEngineListener</a></td> <td class="imsum_right">removes an engine listener. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="setRoot" class="membertitle">setRoot</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setRoot</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xRoot );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets an interface to an object as a scripting root. </dd> <dd><p>If the root object implements the XInvocation interface, then the engine uses this interface to set/get properties and call methods. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRoot" class="membertitle">getRoot</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> </tr> <tr> <td valign="top"><b>getRoot</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets an interface to the object which is the scripting root. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setLibraryAccess" class="membertitle">setLibraryAccess</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setLibraryAccess</b>(</td> <td valign="top">[in] <a href="XLibraryAccess.html">XLibraryAccess</a></td> <td valign="bottom"> Library );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets an access object to get external functions. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="compile" class="membertitle">compile</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>compile</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ModuleName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> Script,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> CreateDebugInfo );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>compiles a script module in the scope of the root object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="run" class="membertitle">run</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>run</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aScript,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xThis,</td> </tr> <tr> <td/><td valign="top">[in] sequence< any ></td> <td valign="bottom"> aArgs );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>runs a script specified by a string. </dd> <dd><p>The arguments given in <var>aArgs</var> can be ignored by the engine. The Script is executed synchronously.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="runAsync" class="membertitle">runAsync</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>runAsync</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> acript,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xThis,</td> </tr> <tr> <td/><td valign="top">[in] sequence< any ></td> <td valign="bottom"> args,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XEngineListener.html">XEngineListener</a></td> <td valign="bottom"> xCallback );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>runs the script specified by a string and makes callbacks. </dd> <dd><p>The arguments given in <var>aArgs</var> can be ignored by the engine. The script is executed asynchronously. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="cancel" class="membertitle">cancel</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>cancel</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>terminates the execution of the running script. </dd> <dd><p>The waiting queue is cleared too.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addEngineListener" class="membertitle">addEngineListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addEngineListener</b>(</td> <td valign="top">[in] <a href="XEngineListener.html">XEngineListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds an engine listener. </dd> <dd><p>It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeEngineListener" class="membertitle">removeEngineListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeEngineListener</b>(</td> <td valign="top">[in] <a href="XEngineListener.html">XEngineListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes an engine listener. </dd> <dd><p>It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
5041
