QAxScript Class

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

Header: #include <QAxScript>
qmake: QT += axcontainer
Inherits: QObject

Public Types

enum FunctionFlags { FunctionNames, FunctionSignatures }

Public Functions

QAxScript(const QString &name, QAxScriptManager *manager)
virtual ~QAxScript() override
QVariant call(const QString &function, const QVariant &v1 = QVariant(), const QVariant &v2 = QVariant(), const QVariant &v3 = QVariant(), const QVariant &v4 = QVariant(), const QVariant &v5 = QVariant(), const QVariant &v6 = QVariant(), const QVariant &v7 = QVariant(), const QVariant &v8 = QVariant())
QVariant call(const QString &function, QList<QVariant> &arguments)
QStringList functions(QAxScript::FunctionFlags = FunctionNames) const
bool load(const QString &code, const QString &language = QString())
QString scriptCode() const
QAxScriptEngine *scriptEngine() const
QString scriptName() const
  • 31 public functions inherited from QObject

Signals

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

Static Public Members

const QMetaObject staticMetaObject
  • 9 static public members inherited from QObject

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 9 protected functions inherited from QObject

Detailed Description

The QAxScript class provides a wrapper around script code.

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.

ConstantValueDescription
QAxScript::FunctionNames0Only function names are returned.
QAxScript::FunctionSignatures1Returns the functions with signatures.

Member Function Documentation

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

Default constructs an instance of QAxScript.

[override virtual] QAxScript::~QAxScript()

Destroys the instance of QAxScript. The destructor is virtual.

QVariant QAxScript::call(const QString &function, const QVariant &v1 = QVariant(), const QVariant &v2 = QVariant(), const QVariant &v3 = QVariant(), const QVariant &v4 = QVariant(), const QVariant &v5 = QVariant(), const QVariant &v6 = QVariant(), const QVariant &v7 = QVariant(), const QVariant &v8 = QVariant())

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

[signal] void QAxScript::entered()

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

[signal] void QAxScript::finished()

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::finished(const QVariant &result)

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(int code, const QString &source, const QString &description, const QString &help)

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){ /* ... */ });

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

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

QString QAxScript::scriptCode() const

QAxScriptEngine *QAxScript::scriptEngine() const

QString QAxScript::scriptName() const

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