| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|---|
| 2 | <!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/extensions/activeqt/container/qaxscript.cpp:360 -->
|
|---|
| 3 | <html>
|
|---|
| 4 | <head>
|
|---|
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|---|
| 6 | <title>QAxScriptEngine Class</title>
|
|---|
| 7 | <style type="text/css"><!--
|
|---|
| 8 | fn { margin-left: 1cm; text-indent: -1cm; }
|
|---|
| 9 | a:link { color: #004faf; text-decoration: none }
|
|---|
| 10 | a:visited { color: #672967; text-decoration: none }
|
|---|
| 11 | body { background: #ffffff; color: black; }
|
|---|
| 12 | --></style>
|
|---|
| 13 | </head>
|
|---|
| 14 | <body>
|
|---|
| 15 |
|
|---|
| 16 | <table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|---|
| 17 | <tr bgcolor="#E5E5E5">
|
|---|
| 18 | <td valign=center>
|
|---|
| 19 | <a href="index.html">
|
|---|
| 20 | <font color="#004faf">Home</font></a>
|
|---|
| 21 | | <a href="classes.html">
|
|---|
| 22 | <font color="#004faf">All Classes</font></a>
|
|---|
| 23 | | <a href="mainclasses.html">
|
|---|
| 24 | <font color="#004faf">Main Classes</font></a>
|
|---|
| 25 | | <a href="annotated.html">
|
|---|
| 26 | <font color="#004faf">Annotated</font></a>
|
|---|
| 27 | | <a href="groups.html">
|
|---|
| 28 | <font color="#004faf">Grouped Classes</font></a>
|
|---|
| 29 | | <a href="functions.html">
|
|---|
| 30 | <font color="#004faf">Functions</font></a>
|
|---|
| 31 | </td>
|
|---|
| 32 | <td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QAxScriptEngine Class Reference<br><small>[<a href="qaxcontainer.html">QAxContainer module</a>]</small></h1>
|
|---|
| 33 |
|
|---|
| 34 | <p>The QAxScriptEngine class provides a wrapper around a script engine.
|
|---|
| 35 | <a href="#details">More...</a>
|
|---|
| 36 | <p>This class is part of the <b>Qt ActiveQt Extension</b>.
|
|---|
| 37 | <p><tt>#include <<a href="qaxscript-h.html">qaxscript.h</a>></tt>
|
|---|
| 38 | <p>Inherits <a href="qaxobject.html">QAxObject</a>.
|
|---|
| 39 | <p><a href="qaxscriptengine-members.html">List of all member functions.</a>
|
|---|
| 40 | <h2>Public Members</h2>
|
|---|
| 41 | <ul>
|
|---|
| 42 | <li class=fn>enum <a href="#State-enum"><b>State</b></a> { Uninitialized = 0, Initialized = 5, Started = 1, Connected = 2, Disconnected = 3, Closed = 4 }</li>
|
|---|
| 43 | <li class=fn><a href="#QAxScriptEngine"><b>QAxScriptEngine</b></a> ( const QString & language, QAxScript * script )</li>
|
|---|
| 44 | <li class=fn><a href="#~QAxScriptEngine"><b>~QAxScriptEngine</b></a> ()</li>
|
|---|
| 45 | <li class=fn>bool <a href="#isValid"><b>isValid</b></a> () const</li>
|
|---|
| 46 | <li class=fn>bool <a href="#hasIntrospection"><b>hasIntrospection</b></a> () const</li>
|
|---|
| 47 | <li class=fn>QString <a href="#scriptLanguage"><b>scriptLanguage</b></a> () const</li>
|
|---|
| 48 | <li class=fn>State <a href="#state"><b>state</b></a> () const</li>
|
|---|
| 49 | <li class=fn>void <a href="#setState"><b>setState</b></a> ( State st )</li>
|
|---|
| 50 | <li class=fn>void <a href="#addItem"><b>addItem</b></a> ( const QString & name )</li>
|
|---|
| 51 | <li class=fn>long <a href="#queryInterface"><b>queryInterface</b></a> ( const QUuid & uuid, void ** iface ) const</li>
|
|---|
| 52 | </ul>
|
|---|
| 53 | <hr><a name="details"></a><h2>Detailed Description</h2>
|
|---|
| 54 | <p> This class is defined in the <b>Qt <a href="activeqt.html#ActiveQt">ActiveQt</a> Extension</b>, which can be found in the <tt>qt/extensions</tt> directory. It is not included in the main Qt API.
|
|---|
| 55 | <p>
|
|---|
| 56 |
|
|---|
| 57 | The QAxScriptEngine class provides a wrapper around a script engine.
|
|---|
| 58 |
|
|---|
| 59 |
|
|---|
| 60 | <p> Every instance of the QAxScriptEngine class represents an interpreter
|
|---|
| 61 | for script code in a particular scripting language. The class is usually
|
|---|
| 62 | not used directly. The <a href="qaxscript.html">QAxScript</a> and <a href="qaxscriptmanager.html">QAxScriptManager</a> classes provide
|
|---|
| 63 | convenient functions to handle and call script code.
|
|---|
| 64 | <p> Direct access to the script engine is provided through
|
|---|
| 65 | <a href="#queryInterface">queryInterface</a>().
|
|---|
| 66 | <p> <b>Warning:</b> This class is not available with the bcc5.5 and MingW
|
|---|
| 67 | compilers.
|
|---|
| 68 |
|
|---|
| 69 | <hr><h2>Member Type Documentation</h2>
|
|---|
| 70 | <h3 class=fn><a name="State-enum"></a>QAxScriptEngine::State</h3>
|
|---|
| 71 |
|
|---|
| 72 | <p> The State enumeration defines the different states a script
|
|---|
| 73 | engine can be in.
|
|---|
| 74 | <ul>
|
|---|
| 75 | <li><tt>QAxScriptEngine::Uninitialized</tt> - The script has been created, but not yet initialized
|
|---|
| 76 | <li><tt>QAxScriptEngine::Initialized</tt> - The script has been initialized, but is not running
|
|---|
| 77 | <li><tt>QAxScriptEngine::Started</tt> - The script can execute code, but does not yet handle events
|
|---|
| 78 | <li><tt>QAxScriptEngine::Connected</tt> - The script can execute code and is connected so
|
|---|
| 79 | that it can handle events
|
|---|
| 80 | <li><tt>QAxScriptEngine::Disconnected</tt> - The script is loaded, but is not connected to
|
|---|
| 81 | event sources
|
|---|
| 82 | <li><tt>QAxScriptEngine::Closed</tt> - The script has been closed.
|
|---|
| 83 | </ul>
|
|---|
| 84 | <hr><h2>Member Function Documentation</h2>
|
|---|
| 85 | <h3 class=fn><a name="QAxScriptEngine"></a>QAxScriptEngine::QAxScriptEngine ( const <a href="qstring.html">QString</a> & language, <a href="qaxscript.html">QAxScript</a> * script )
|
|---|
| 86 | </h3>
|
|---|
| 87 | Constructs a QAxScriptEngine object interpreting script code in <em>language</em>
|
|---|
| 88 | provided by the code in <em>script</em>. This is usually done by the <a href="qaxscript.html">QAxScript</a>
|
|---|
| 89 | class when <a href="qaxscript.html#load">loading a script</a>.
|
|---|
| 90 | <p> Instances of QAxScriptEngine should always have both a language and a
|
|---|
| 91 | script.
|
|---|
| 92 |
|
|---|
| 93 | <h3 class=fn><a name="~QAxScriptEngine"></a>QAxScriptEngine::~QAxScriptEngine ()
|
|---|
| 94 | </h3>
|
|---|
| 95 | Destroys the QAxScriptEngine object, releasing all allocated
|
|---|
| 96 | resources.
|
|---|
| 97 |
|
|---|
| 98 | <h3 class=fn>void <a name="addItem"></a>QAxScriptEngine::addItem ( const <a href="qstring.html">QString</a> & name )
|
|---|
| 99 | </h3>
|
|---|
| 100 | Registers an item with the script engine. Script code can
|
|---|
| 101 | refer to this item using <em>name</em>.
|
|---|
| 102 |
|
|---|
| 103 | <h3 class=fn>bool <a name="hasIntrospection"></a>QAxScriptEngine::hasIntrospection () const
|
|---|
| 104 | </h3>
|
|---|
| 105 | Returns TRUE if the script engine supports introspection;
|
|---|
| 106 | otherwise returns FALSE.
|
|---|
| 107 |
|
|---|
| 108 | <h3 class=fn>bool <a name="isValid"></a>QAxScriptEngine::isValid () const
|
|---|
| 109 | </h3>
|
|---|
| 110 |
|
|---|
| 111 | <p> Returns TRUE if the script engine has been initialized
|
|---|
| 112 | correctly; otherwise returns FALSE.
|
|---|
| 113 |
|
|---|
| 114 | <h3 class=fn>long <a name="queryInterface"></a>QAxScriptEngine::queryInterface ( const <a href="quuid.html">QUuid</a> & uuid, void ** iface ) const
|
|---|
| 115 | </h3>
|
|---|
| 116 | Requests the interface <em>uuid</em> from the script engine object and
|
|---|
| 117 | sets the value of <em>iface</em> to the provided interface, or to 0 if
|
|---|
| 118 | the requested interface could not be provided.
|
|---|
| 119 | <p> Returns the result of the QueryInterface implementation of the COM
|
|---|
| 120 | object.
|
|---|
| 121 |
|
|---|
| 122 | <h3 class=fn><a href="qstring.html">QString</a> <a name="scriptLanguage"></a>QAxScriptEngine::scriptLanguage () const
|
|---|
| 123 | </h3>
|
|---|
| 124 | Returns the scripting language, for example "VBScript",
|
|---|
| 125 | or "JScript".
|
|---|
| 126 |
|
|---|
| 127 | <h3 class=fn>void <a name="setState"></a>QAxScriptEngine::setState ( <a href="qaxscriptengine.html#State-enum">State</a> st )
|
|---|
| 128 | </h3>
|
|---|
| 129 | Sets the state of the script engine to <em>st</em>.
|
|---|
| 130 | Calling this function is usually not necessary.
|
|---|
| 131 |
|
|---|
| 132 | <h3 class=fn><a href="qaxscriptengine.html#State-enum">State</a> <a name="state"></a>QAxScriptEngine::state () const
|
|---|
| 133 | </h3>
|
|---|
| 134 | Returns the state of the script engine.
|
|---|
| 135 |
|
|---|
| 136 | <!-- eof -->
|
|---|
| 137 | <hr><p>
|
|---|
| 138 | This file is part of the <a href="index.html">Qt toolkit</a>.
|
|---|
| 139 | Copyright © 1995-2007
|
|---|
| 140 | <a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
|
|---|
| 141 | <table width=100% cellspacing=0 border=0><tr>
|
|---|
| 142 | <td>Copyright © 2007
|
|---|
| 143 | <a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
|
|---|
| 144 | <td align=right><div align=right>Qt 3.3.8</div>
|
|---|
| 145 | </table></div></address></body>
|
|---|
| 146 | </html>
|
|---|
