<?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/style.css" /> <script src="scripts/jquery.js" type="text/javascript"></script> <script src="scripts/functions.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="style/superfish.css" /> <link rel="stylesheet" type="text/css" href="style/narrow.css" /> <!--[if IE]> <meta name="MSSmartTagsPreventParsing" content="true"> <meta http-equiv="imagetoolbar" content="no"> <![endif]--> <!--[if lt IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie6.css"> <![endif]--> <!--[if IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie7.css"> <![endif]--> <!--[if IE 8]> <link rel="stylesheet" type="text/css" href="style/style_ie8.css"> <![endif]--> <script src="scripts/superfish.js" type="text/javascript"></script> <script src="scripts/narrow.js" type="text/javascript"></script> </head> <body class="" onload="CheckEmptyAndLoadList();"> <div class="header" id="qtdocheader"> <div class="content"> <div id="nav-logo"> <a href="index.html">Home</a></div> <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a> <div id="narrowsearch"></div> <div id="nav-topright"> <ul> <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li> <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li> <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/"> DOC</a></li> <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li> </ul> </div> <div id="shortCut"> <ul> <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li> <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li> </ul> </div> <ul class="sf-menu" id="narrowmenu"> <li><a href="#">API Lookup</a> <ul> <li><a href="classes.html">Class index</a></li> <li><a href="functions.html">Function index</a></li> <li><a href="modules.html">Modules</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="qtglobal.html">Global Declarations</a></li> <li><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </li> <li><a href="#">Qt Topics</a> <ul> <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li><a href="supported-platforms.html">Supported Platforms</a></li> <li><a href="technology-apis.html">Qt and Key Technologies</a></li> <li><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </li> <li><a href="#">Examples</a> <ul> <li><a href="all-examples.html">Examples</a></li> <li><a href="tutorials.html">Tutorials</a></li> <li><a href="demos.html">Demos</a></li> <li><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </li> </ul> </div> </div> <div class="wrapper"> <div class="hd"> <span></span> </div> <div class="bd group"> <div class="sidebar"> <div class="searchlabel"> Search index:</div> <div class="search" id="sidebarsearch"> <form id="qtdocsearch" action="" onsubmit="return false;"> <fieldset> <input type="text" name="searchstring" id="pageType" value="" /> <div id="resultdialog"> <a href="#" id="resultclose">Close</a> <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p> <ul id="resultlist" class="all"> </ul> </div> </fieldset> </form> </div> <div class="box first bottombar" id="lookup"> <h2 title="API Lookup"><span></span> API Lookup</h2> <div id="list001" class="list"> <ul id="ul001" > <li class="defaultLink"><a href="classes.html">Class index</a></li> <li class="defaultLink"><a href="functions.html">Function index</a></li> <li class="defaultLink"><a href="modules.html">Modules</a></li> <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li> <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li> <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </div> </div> <div class="box bottombar" id="topics"> <h2 title="Qt Topics"><span></span> Qt Topics</h2> <div id="list002" class="list"> <ul id="ul002" > <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li> <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </div> </div> <div class="box" id="examples"> <h2 title="Examples"><span></span> Examples</h2> <div id="list003" class="list"> <ul id="ul003"> <li class="defaultLink"><a href="all-examples.html">Examples</a></li> <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li> <li class="defaultLink"><a href="demos.html">Demos</a></li> <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </div> </div> </div> <div class="wrap"> <div class="toolbar"> <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 class="toolbuttons toolblock"> <ul> <li id="smallA" class="t_button">A</li> <li id="medA" class="t_button active">A</li> <li id="bigA" class="t_button">A</li> <li id="print" class="t_button"><a href="javascript:this.print();"> <span>Print</span></a></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 <QAxScriptEngine></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 & <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 & <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 & <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> & <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> & <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> & <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 "VBScript", or "JScript".</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> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd. 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> Qt and respective logos are trademarks of The Qt Company Ltd 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> <script src="scripts/functions.js" type="text/javascript"></script> </body> </html>