QAxScriptEngine(3qt)

1QAxScriptEngine(3qt)                                      QAxScriptEngine(3qt)
2
3
4

NAME

6       QAxScriptEngine - Wrapper around a script engine
7

SYNOPSIS

9       This class is part of the Qt ActiveQt Extension.
10
11       #include <qaxscript.h>
12
13       Inherits QAxObject.
14
15   Public Members
16       enum State { Uninitialized = 0, Initialized = 5, Started = 1, Connected
17           = 2, Disconnected = 3, Closed = 4 }
18       QAxScriptEngine ( const QString & language, QAxScript * script )
19       ~QAxScriptEngine ()
20       bool isValid () const
21       bool hasIntrospection () const
22       QString scriptLanguage () const
23       State state () const
24       void setState ( State st )
25       void addItem ( const QString & name )
26       long queryInterface ( const QUuid & uuid, void ** iface ) const
27

DESCRIPTION

29       This class is defined in the Qt ActiveQt Extension, which can be found
30       in the qt/extensions directory. It is not included in the main Qt API.
31
32       The QAxScriptEngine class provides a wrapper around a script engine.
33
34       Every instance of the QAxScriptEngine class represents an interpreter
35       for script code in a particular scripting language. The class is
36       usually not used directly. The QAxScript and QAxScriptManager classes
37       provide convenient functions to handle and call script code.
38
39       Direct access to the script engine is provided through
40       queryInterface().
41
42       Warning: This class is not available with the bcc5.5 and MingW
43       compilers.
44
45   Member Type Documentation

QAxScriptEngine::State

47       The State enumeration defines the different states a script engine can
48       be in.
49
50       QAxScriptEngine::Uninitialized - The script has been created, but not
51       yet initialized
52
53       QAxScriptEngine::Initialized - The script has been initialized, but is
54       not running
55
56       QAxScriptEngine::Started - The script can execute code, but does not
57       yet handle events
58
59       QAxScriptEngine::Connected - The script can execute code and is
60       connected so that it can handle events
61
62       QAxScriptEngine::Disconnected - The script is loaded, but is not
63       connected to event sources
64
65       QAxScriptEngine::Closed - The script has been closed.
66

MEMBER FUNCTION DOCUMENTATION

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

69       script )
70       Constructs a QAxScriptEngine object interpreting script code in
71       language provided by the code in script. This is usually done by the
72       QAxScript class when loading a script.
73
74       Instances of QAxScriptEngine should always have both a language and a
75       script.
76

QAxScriptEngine::~QAxScriptEngine ()

78       Destroys the QAxScriptEngine object, releasing all allocated resources.
79

void QAxScriptEngine::addItem ( const QString & name )

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

bool QAxScriptEngine::hasIntrospection () const

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

bool QAxScriptEngine::isValid () const

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

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

93       const
94       Requests the interface uuid from the script engine object and sets the
95       value of iface to the provided interface, or to 0 if the requested
96       interface could not be provided.
97
98       Returns the result of the QueryInterface implementation of the COM
99       object.
100

QString QAxScriptEngine::scriptLanguage () const

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

void QAxScriptEngine::setState ( State st )

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

State QAxScriptEngine::state () const

109       Returns the state of the script engine.
110
111

COPYRIGHT

117       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
118       license file included in the distribution for a complete license
119       statement.
120

AUTHOR

122       Generated automatically from the source code.
123

BUGS

125       If you find a bug in Qt, please report it as described in
126       http://doc.trolltech.com/bughowto.html.  Good bug reports help us to
127       help you. Thank you.
128
129       The definitive Qt documentation is provided in HTML format; it is
130       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
131       web browser. This man page is provided as a convenience for those users
132       who prefer man pages, although this format is not officially supported
133       by Trolltech.
134
135       If you find errors in this manual page, please report them to qt-
136       bugs@trolltech.com.  Please include the name of the manual page
137       (qaxscriptengine.3qt) and the Qt version (3.3.8).
138
139
140
141Trolltech AS                    2 February 2007           QAxScriptEngine(3qt)