summaryrefslogtreecommitdiffstats
path: root/doc/html/qaxscriptengine.html
blob: 93478a2f4199294eebf5c09d8e6ee477c919900e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/extensions/activeqt/container/qaxscript.cpp:360 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>TQAxScriptEngine Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQAxScriptEngine Class Reference<br><small>[<a href="qaxcontainer.html">TQAxContainer module</a>]</small></h1>

<p>The TQAxScriptEngine class provides a wrapper around a script engine.
<a href="#details">More...</a>
<p>This class is part of the <b>TQt ActiveTQt Extension</b>.
<p><tt>#include &lt;<a href="qaxscript-h.html">qaxscript.h</a>&gt;</tt>
<p>Inherits <a href="qaxobject.html">TQAxObject</a>.
<p><a href="qaxscriptengine-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<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>
<li class=fn><a href="#TQAxScriptEngine"><b>TQAxScriptEngine</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;language, TQAxScript&nbsp;*&nbsp;script )</li>
<li class=fn><a href="#~TQAxScriptEngine"><b>~TQAxScriptEngine</b></a> ()</li>
<li class=fn>bool <a href="#isValid"><b>isValid</b></a> () const</li>
<li class=fn>bool <a href="#hasIntrospection"><b>hasIntrospection</b></a> () const</li>
<li class=fn>TQString <a href="#scriptLanguage"><b>scriptLanguage</b></a> () const</li>
<li class=fn>State <a href="#state"><b>state</b></a> () const</li>
<li class=fn>void <a href="#setState"><b>setState</b></a> ( State&nbsp;st )</li>
<li class=fn>void <a href="#addItem"><b>addItem</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;name )</li>
<li class=fn>long <a href="#queryInterface"><b>queryInterface</b></a> ( const&nbsp;TQUuid&nbsp;&amp;&nbsp;uuid, void&nbsp;**&nbsp;iface ) const</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
<p> This class is defined in the <b>TQt <a href="activeqt.html#ActiveTQt">ActiveTQt</a> Extension</b>, which can be found in the <tt>qt/extensions</tt> directory. It is not included in the main TQt API.
<p>

The TQAxScriptEngine class provides a wrapper around a script engine.


<p> Every instance of the TQAxScriptEngine class represents an interpreter
for script code in a particular scripting language. The class is usually
not used directly. The <a href="qaxscript.html">TQAxScript</a> and <a href="qaxscriptmanager.html">TQAxScriptManager</a> classes provide
convenient functions to handle and call script code.
<p> Direct access to the script engine is provided through
<a href="#queryInterface">queryInterface</a>().
<p> <b>Warning:</b> This class is not available with the bcc5.5 and MingW
compilers.

<hr><h2>Member Type Documentation</h2>
<h3 class=fn><a name="State-enum"></a>TQAxScriptEngine::State</h3>

<p> The State enumeration defines the different states a script
engine can be in.
<ul>
<li><tt>TQAxScriptEngine::Uninitialized</tt> - The script has been created, but not yet initialized
<li><tt>TQAxScriptEngine::Initialized</tt> - The script has been initialized, but is not running
<li><tt>TQAxScriptEngine::Started</tt> - The script can execute code, but does not yet handle events
<li><tt>TQAxScriptEngine::Connected</tt> - The script can execute code and is connected so
that it can handle events
<li><tt>TQAxScriptEngine::Disconnected</tt> - The script is loaded, but is not connected to
event sources
<li><tt>TQAxScriptEngine::Closed</tt> - The script has been closed.
</ul>
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="TQAxScriptEngine"></a>TQAxScriptEngine::TQAxScriptEngine ( const&nbsp;<a href="qstring.html">TQString</a>&nbsp;&amp;&nbsp;language, <a href="qaxscript.html">TQAxScript</a>&nbsp;*&nbsp;script )
</h3>
Constructs a TQAxScriptEngine object interpreting script code in <em>language</em>
provided by the code in <em>script</em>. This is usually done by the <a href="qaxscript.html">TQAxScript</a> 
class when <a href="qaxscript.html#load">loading a script</a>.
<p> Instances of TQAxScriptEngine should always have both a language and a
script.

<h3 class=fn><a name="~TQAxScriptEngine"></a>TQAxScriptEngine::~TQAxScriptEngine ()
</h3>
Destroys the TQAxScriptEngine object, releasing all allocated
resources.

<h3 class=fn>void <a name="addItem"></a>TQAxScriptEngine::addItem ( const&nbsp;<a href="qstring.html">TQString</a>&nbsp;&amp;&nbsp;name )
</h3>
Registers an item with the script engine. Script code can
refer to this item using <em>name</em>.

<h3 class=fn>bool <a name="hasIntrospection"></a>TQAxScriptEngine::hasIntrospection () const
</h3>
Returns TRUE if the script engine supports introspection;
otherwise returns FALSE.

<h3 class=fn>bool <a name="isValid"></a>TQAxScriptEngine::isValid () const
</h3>

<p> Returns TRUE if the script engine has been initialized
correctly; otherwise returns FALSE.

<h3 class=fn>long <a name="queryInterface"></a>TQAxScriptEngine::queryInterface ( const&nbsp;<a href="quuid.html">TQUuid</a>&nbsp;&amp;&nbsp;uuid, void&nbsp;**&nbsp;iface ) const
</h3>
Requests the interface <em>uuid</em> from the script engine object and
sets the value of <em>iface</em> to the provided interface, or to 0 if
the requested interface could not be provided.
<p> Returns the result of the QueryInterface implementation of the COM
object.

<h3 class=fn><a href="qstring.html">TQString</a> <a name="scriptLanguage"></a>TQAxScriptEngine::scriptLanguage () const
</h3> 
Returns the scripting language, for example "VBScript",
or "JScript".

<h3 class=fn>void <a name="setState"></a>TQAxScriptEngine::setState ( <a href="qaxscriptengine.html#State-enum">State</a>&nbsp;st )
</h3>
Sets the state of the script engine to <em>st</em>.
Calling this function is usually not necessary.

<h3 class=fn><a href="qaxscriptengine.html#State-enum">State</a> <a name="state"></a>TQAxScriptEngine::state () const
</h3>
Returns the state of the script engine.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">TQt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>TQt 3.3.8</div>
</table></div></address></body>
</html>