File: qaxscriptengine.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (186 lines) | stat: -rw-r--r-- 14,043 bytes parent folder | download 
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaxscript.cpp -->
  <title>Qt 4.8: QAxScriptEngine Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qaxcontainer.html">QAxContainer</a></li>
<li>QAxScriptEngine</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QAxScriptEngine Class Reference</h1>
<!-- $$$QAxScriptEngine-brief -->
<p>The QAxScriptEngine class provides a wrapper around a script engine. <a href="#details">More...</a></p>
<!-- @@@QAxScriptEngine -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QAxScriptEngine&gt;</span></pre><p><b>Inherits: </b><a href="qaxobject.html">QAxObject</a>.</p>
<ul>
<li><a href="qaxscriptengine-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#State-enum">State</a></b> { Uninitialized, Initialized, Started, Connected, Disconnected, Closed }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#QAxScriptEngine">QAxScriptEngine</a></b> ( const QString &amp; <i>language</i>, QAxScript * <i>script</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#dtor.QAxScriptEngine">~QAxScriptEngine</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#addItem">addItem</a></b> ( const QString &amp; <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#hasIntrospection">hasIntrospection</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> long </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#queryInterface">queryInterface</a></b> ( const QUuid &amp; <i>uuid</i>, void ** <i>iface</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#scriptLanguage">scriptLanguage</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#setState">setState</a></b> ( State <i>st</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> State </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#state">state</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">1 public function inherited from <a href="qaxobject.html#public-functions">QAxObject</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
<li class="fn">19 public functions inherited from <a href="qaxbase.html#public-functions">QAxBase</a></li>
</ul>
<a name="reimplemented-protected-functions"></a>
<h2>Reimplemented Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qaxscriptengine.html#initialize">initialize</a></b> ( IUnknown ** <i>ptr</i> )</td></tr>
</table>
<ul>
<li class="fn">1 protected function inherited from <a href="qaxobject.html#protected-functions">QAxObject</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
<li class="fn">5 protected functions inherited from <a href="qaxbase.html#protected-functions">QAxBase</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">1 property inherited from <a href="qaxbase.html#properties">QAxBase</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
<li class="fn">3 signals inherited from <a href="qaxbase.html#signals">QAxBase</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">1 protected function inherited from <a href="qaxobject.html#protected-functions">QAxObject</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
<li class="fn">5 protected functions inherited from <a href="qaxbase.html#protected-functions">QAxBase</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAxScriptEngine-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAxScriptEngine class provides a wrapper around a script engine.</p>
<p>Every instance of the QAxScriptEngine class represents an interpreter for script code in a particular scripting language. The class is usually not used directly. The <a href="qaxscript.html">QAxScript</a> and <a href="qaxscriptmanager.html">QAxScriptManager</a> classes provide convenient functions to handle and call script code.</p>
<p>Direct access to the script engine is provided through <a href="qaxscriptengine.html#queryInterface">queryInterface</a>().</p>
<p><b>Warning:</b> This class is not available with the bcc5.5 and MingW compilers.</p>
</div>
<p><b>See also </b><a href="qaxscript.html">QAxScript</a>, <a href="qaxscriptmanager.html">QAxScriptManager</a>, <a href="qaxbase.html">QAxBase</a>, and <a href="activeqt.html#activeqt-framework">ActiveQt Framework</a>.</p>
<!-- @@@QAxScriptEngine -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$State$$$Uninitialized$$$Initialized$$$Started$$$Connected$$$Disconnected$$$Closed -->
<h3 class="fn"><a name="State-enum"></a>enum QAxScriptEngine::<span class="name">State</span></h3>
<p>The State enumeration defines the different states a script engine can be in.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QAxScriptEngine::Uninitialized</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The script has been created, but not yet initialized</td></tr>
<tr><td class="topAlign"><tt>QAxScriptEngine::Initialized</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">The script has been initialized, but is not running</td></tr>
<tr><td class="topAlign"><tt>QAxScriptEngine::Started</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The script can execute code, but does not yet handle events</td></tr>
<tr><td class="topAlign"><tt>QAxScriptEngine::Connected</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The script can execute code and is connected so that it can handle events</td></tr>
<tr><td class="topAlign"><tt>QAxScriptEngine::Disconnected</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The script is loaded, but is not connected to event sources</td></tr>
<tr><td class="topAlign"><tt>QAxScriptEngine::Closed</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The script has been closed.</td></tr>
</table>
<!-- @@@State -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAxScriptEngine[overload1]$$$QAxScriptEngineconstQString&QAxScript* -->
<h3 class="fn"><a name="QAxScriptEngine"></a>QAxScriptEngine::<span class="name">QAxScriptEngine</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>language</i>, <span class="type"><a href="qaxscript.html">QAxScript</a></span> * <i>script</i> )</h3>
<p>Constructs a <a href="qaxscriptengine.html">QAxScriptEngine</a> object interpreting script code in <i>language</i> provided by the code in <i>script</i>. This is usually done by the <a href="qaxscript.html">QAxScript</a> class when <a href="qaxscript.html#load">loading a script</a>.</p>
<p>Instances of <a href="qaxscriptengine.html">QAxScriptEngine</a> should always have both a language and a script.</p>
<!-- @@@QAxScriptEngine -->
<!-- $$$~QAxScriptEngine[overload1]$$$~QAxScriptEngine -->
<h3 class="fn"><a name="dtor.QAxScriptEngine"></a>QAxScriptEngine::<span class="name">~QAxScriptEngine</span> ()</h3>
<p>Destroys the <a href="qaxscriptengine.html">QAxScriptEngine</a> object, releasing all allocated resources.</p>
<!-- @@@~QAxScriptEngine -->
<!-- $$$addItem[overload1]$$$addItemconstQString& -->
<h3 class="fn"><a name="addItem"></a><span class="type">void</span> QAxScriptEngine::<span class="name">addItem</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>name</i> )</h3>
<p>Registers an item with the script engine. Script code can refer to this item using <i>name</i>.</p>
<!-- @@@addItem -->
<!-- $$$hasIntrospection[overload1]$$$hasIntrospection -->
<h3 class="fn"><a name="hasIntrospection"></a><span class="type">bool</span> QAxScriptEngine::<span class="name">hasIntrospection</span> () const</h3>
<p>Returns true if the script engine supports introspection; otherwise returns false.</p>
<!-- @@@hasIntrospection -->
<!-- $$$initialize[overload1]$$$initializeIUnknown** -->
<h3 class="fn"><a name="initialize"></a><span class="type">bool</span> QAxScriptEngine::<span class="name">initialize</span> ( <span class="type">IUnknown</span> ** <i>ptr</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qaxbase.html#initialize">QAxBase::initialize</a>().</p>
<!-- @@@initialize -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QAxScriptEngine::<span class="name">isValid</span> () const</h3>
<p>Returns true if the script engine has been initialized correctly; otherwise returns false.</p>
<!-- @@@isValid -->
<!-- $$$queryInterface[overload1]$$$queryInterfaceconstQUuid&void** -->
<h3 class="fn"><a name="queryInterface"></a><span class="type">long</span> QAxScriptEngine::<span class="name">queryInterface</span> ( const <span class="type"><a href="quuid.html">QUuid</a></span> &amp; <i>uuid</i>, <span class="type">void</span> ** <i>iface</i> ) const</h3>
<p>Requests the interface <i>uuid</i> from the script engine object and sets the value of <i>iface</i> to the provided interface, or to 0 if the requested interface could not be provided.</p>
<p>Returns the result of the QueryInterface implementation of the COM object.</p>
<!-- @@@queryInterface -->
<!-- $$$scriptLanguage[overload1]$$$scriptLanguage -->
<h3 class="fn"><a name="scriptLanguage"></a><span class="type"><a href="qstring.html">QString</a></span> QAxScriptEngine::<span class="name">scriptLanguage</span> () const</h3>
<p>Returns the scripting language, for example &quot;VBScript&quot;, or &quot;JScript&quot;.</p>
<!-- @@@scriptLanguage -->
<!-- $$$setState[overload1]$$$setStateState -->
<h3 class="fn"><a name="setState"></a><span class="type">void</span> QAxScriptEngine::<span class="name">setState</span> ( <span class="type"><a href="qaxscriptengine.html#State-enum">State</a></span> <i>st</i> )</h3>
<p>Sets the state of the script engine to <i>st</i>. Calling this function is usually not necessary.</p>
<p><b>See also </b><a href="qaxscriptengine.html#state">state</a>().</p>
<!-- @@@setState -->
<!-- $$$state[overload1]$$$state -->
<h3 class="fn"><a name="state"></a><span class="type"><a href="qaxscriptengine.html#State-enum">State</a></span> QAxScriptEngine::<span class="name">state</span> () const</h3>
<p>Returns the state of the script engine.</p>
<p><b>See also </b><a href="qaxscriptengine.html#setState">setState</a>().</p>
<!-- @@@state -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>