QAxScript Class | Active Qt 6.4.1

- Qt 6.4
- Active Qt
- QAxContainer
- QAxScript
- Qt 6.4.1 Reference Documentation

# QAxScript Class

The QAxScript class provides a wrapper around script code. More...

Header: | #include <QAxScript>
CMake: | find_package(Qt6 REQUIRED COMPONENTS AxContainer) target_link_libraries(mytarget PRIVATE Qt6::AxContainer)
qmake: | QT += axcontainer

- List of all members, including inherited members

## Public Types

enum | FunctionFlags { FunctionNames, FunctionSignatures }

## Public Functions

| QAxScript(const QString &name, QAxScriptManager *manager)
virtual | ~QAxScript() override
QVariant | call(const QString &function, const QVariant &var1 = QVariant(), const QVariant &var2 = QVariant(), const QVariant &var3 = QVariant(), const QVariant &var4 = QVariant(), const QVariant &var5 = QVariant(), const QVariant &var6 = QVariant(), const QVariant &var7 = QVariant(), const QVariant &var8 = QVariant())
QVariant | call(const QString &function, QList<QVariant> &arguments)
QStringList | functions(QAxScript::FunctionFlags flags = FunctionNames) const
bool | load(const QString &code, const QString &language = QString())
QString | scriptCode() const
QAxScriptEngine * | scriptEngine() const
QString | scriptName() const

## Signals

void | entered()
void | error(int code, const QString &description, int sourcePosition, const QString &sourceText)
void | finished(int code, const QString &source, const QString &description, const QString &help)
void | finished(const QVariant &result)
void | finished()
void | stateChanged(int state)

## Detailed Description

Every instance of the QAxScript class represents a piece of scripting code in a particular scripting language. The code is loaded into the script engine using load(). Functions declared in the code can be called using call().

The script provides scriptEngine() provides feedback to the application through signals. The most important signal is the error() signal. Direct access to the QAxScriptEngine is provided through the scriptEngine() function.

Warning: This class is not available with the bcc5.5 compiler.

See also QAxScriptEngine, QAxScriptManager, QAxBase, and ActiveQt Framework.

## Member Type Documentation

### enum QAxScript::FunctionFlags

This FunctionFlags enum describes formatting for function introspection.

Constant | Value | Description
--- | --- | ---
`QAxScript::FunctionNames` | `0` | Only function names are returned.
`QAxScript::FunctionSignatures` | `1` | Returns the functions with signatures.

## Member Function Documentation

### QAxScript::QAxScript(const QString &name, QAxScriptManager *manager)

Constructs a QAxScript object called name and registers it with the QAxScriptManager manager. This is usually done by the QAxScriptManager class when loading a script.

A script should always have a name. A manager is necessary to allow the script code to reference objects in the application. The manager takes ownership of the object.

### `[signal]` void QAxScript::entered()

This signal is emitted when a script engine has started executing code.

### `[signal]` void QAxScript::error(int code, const QString &description, int sourcePosition, const QString &sourceText)

This signal is emitted when an execution error occurred while running a script.

code, description, sourcePosition and sourceText contain information about the execution error.

### `[signal]` void QAxScript::finished(int code, const QString &source, const QString &description, const QString &help)

This is an overloaded function.

code, source, description and help contain exception information when the script terminated.

Note: Signal finished is overloaded in this class. To connect to this signal by using the function pointer syntax, Qt provides a convenient helper for obtaining the function pointer as shown in this example:

     connect(axScript, QOverload<int, const QString &, const QString &, const QString &>::of(&QAxScript::finished),
         [=](int code, const QString &source, const QString &description, const QString &help){ /* ... */ });

### `[signal]` void QAxScript::finished(const QVariant &result)

This is an overloaded function.

result contains the script's result. This will be an invalid QVariant if the script has no return value.

Note: Signal finished is overloaded in this class. To connect to this signal by using the function pointer syntax, Qt provides a convenient helper for obtaining the function pointer as shown in this example:

     connect(axScript, QOverload<const QVariant &>::of(&QAxScript::finished),
         [=](const QVariant &result){ /* ... */ });

### `[signal]` void QAxScript::finished()

This signal is emitted when a script engine has finished executing code.

Note: Signal finished is overloaded in this class. To connect to this signal by using the function pointer syntax, Qt provides a convenient helper for obtaining the function pointer as shown in this example:

     connect(axScript, QOverload<>::of(&QAxScript::finished),
         [=](){ /* ... */ });

### `[signal]` void QAxScript::stateChanged(int state)

This signal is emitted when a script engine changes state. state can be any value in the `QAxScriptEngine::State` enumeration.

### `[override virtual]` QAxScript::~QAxScript()

Destroys the object, releasing all allocated resources.

### QVariant QAxScript::call(const QString &function, const QVariant &var1 = QVariant(), const QVariant &var2 = QVariant(), const QVariant &var3 = QVariant(), const QVariant &var4 = QVariant(), const QVariant &var5 = QVariant(), const QVariant &var6 = QVariant(), const QVariant &var7 = QVariant(), const QVariant &var8 = QVariant())

Calls function, passing the parameters var1, var1, var2, var3, var4, var5, var6, var7 and var8 as arguments and returns the value returned by the function, or an invalid QVariant if the function does not return a value or when the function call failed.

See QAxScriptManager::call() for more information about how to call script functions.

### QVariant QAxScript::call(const QString &function, QList<QVariant> &arguments)

This is an overloaded function.

Calls function passing arguments as parameters, and returns the result. Returns when the script's execution has finished.

See QAxScriptManager::call() for more information about how to call script functions.

### QStringList QAxScript::functions(QAxScript::FunctionFlags flags = FunctionNames) const

Returns a list of all the functions in this script if the respective script engine supports introspection; otherwise returns an empty list. The functions are either provided with full prototypes or only as names, depending on the value of flags.

See also QAxScriptEngine::hasIntrospection().

### bool QAxScript::load(const QString &code, const QString &language = QString())

Loads the script source code written in language language into the script engine. Returns true if code was successfully entered into the script engine; otherwise returns false.

If language is empty (the default) it will be determined heuristically. If code contains the string `End Sub` it will be interpreted as VBScript, otherwise as JScript. Additional scripting languages can be registered using QAxScriptManager::registerEngine().

This function can only be called once for each QAxScript object, which is done automatically when using QAxScriptManager::load().

### QString QAxScript::scriptCode() const

Returns the script's code, or the null-string if no code has been loaded yet.

See also load().

### QAxScriptEngine *QAxScript::scriptEngine() const

Returns a pointer to the script engine.

You can use the object returned to connect signals to the script functions, or to access the script engine directly.

### QString QAxScript::scriptName() const

Returns the name of the script.