QAxScriptEngine

Section: Misc. Reference Manual Pages (3qt)
Updated: 2 February 2007
Index Return to Main Contents

NAME

QAxScriptEngine - Wrapper around a script engine

SYNOPSIS

This class is part of the Qt ActiveQt Extension.

Inherits QAxObject.

Public Members

enum State { Uninitialized = 0, Initialized = 5, Started = 1, Connected = 2, Disconnected = 3, Closed = 4 }

QAxScriptEngine ( const QString & language, QAxScript * script )

~QAxScriptEngine ()

bool isValid () const

bool hasIntrospection () const

QString scriptLanguage () const

State state () const

void setState ( State st )

void addItem ( const QString & name )

long queryInterface ( const QUuid & uuid, void ** iface ) const

DESCRIPTION

This class is defined in the Qt ActiveQt Extension, which can be found in the qt/extensions directory. It is not included in the main Qt API.

The QAxScriptEngine class provides a wrapper around a script engine.

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 QAxScript and QAxScriptManager classes provide convenient functions to handle and call script code.

Direct access to the script engine is provided through queryInterface().

Warning: This class is not available with the bcc5.5 and MingW compilers.

Member Type Documentation

QAxScriptEngine::State

The State enumeration defines the different states a script engine can be in.

QAxScriptEngine::Uninitialized - The script has been created, but not yet initialized
QAxScriptEngine::Initialized - The script has been initialized, but is not running
QAxScriptEngine::Started - The script can execute code, but does not yet handle events
QAxScriptEngine::Connected - The script can execute code and is connected so that it can handle events
QAxScriptEngine::Disconnected - The script is loaded, but is not connected to event sources
QAxScriptEngine::Closed - The script has been closed.

MEMBER FUNCTION DOCUMENTATION

QAxScriptEngine::QAxScriptEngine ( const QString & language, QAxScript * script )

Constructs a QAxScriptEngine object interpreting script code in language provided by the code in script. This is usually done by the QAxScript class when loading a script.

Instances of QAxScriptEngine should always have both a language and a script.

QAxScriptEngine::~QAxScriptEngine ()

Destroys the QAxScriptEngine object, releasing all allocated resources.

void QAxScriptEngine::addItem ( const QString & name )

Registers an item with the script engine. Script code can refer to this item using name.

bool QAxScriptEngine::hasIntrospection () const

Returns TRUE if the script engine supports introspection; otherwise returns FALSE.

bool QAxScriptEngine::isValid () const

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

long QAxScriptEngine::queryInterface ( const QUuid & uuid, void ** iface ) const

Requests the interface uuid from the script engine object and sets the value of iface to the provided interface, or to 0 if the requested interface could not be provided.

Returns the result of the QueryInterface implementation of the COM object.

QString QAxScriptEngine::scriptLanguage () const

Returns the scripting language, for example "VBScript", or "JScript".

void QAxScriptEngine::setState ( State st )

Sets the state of the script engine to st. Calling this function is usually not necessary.

State QAxScriptEngine::state () const

Returns the state of the script engine.

COPYRIGHT

AUTHOR

Generated automatically from the source code.

BUGS

If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you. The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech. If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qaxscriptengine.3qt) and the Qt version (3.3.8).