Класс QAxScript

Класс QAxScript предоставляет оболочку вокруг кода сценария. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Типы публичного доступа

Функции публичного доступа

• 31 функция унаследованная от QObject

Сигналы

• 2 сигнала унаследованных от QObject

Статические публичные члены

• 9 статических публичных членов, унаследованных от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 публичный слот, унаследованный от QObject
• 9 защищённых функций, унаследованных от QObject

Подробное описание

Класс QAxScript предоставляет оболочку вокруг кода сценария.

Каждый экземпляр класса QAxScript представляет собой фрагмент кода сценария на конкретном языке сценариев. Код загружается в движок сценария с помощью load(). Объявленные в коде функции могут вызываться с помощью call().

Сценарий предоставляет scriptEngine() обратную связь приложению через сигналы. Наиболее важный сигнал — сигнал error(). Прямой доступ к QAxScriptEngine предоставляется функцией scriptEngine().

Предупреждение: Этот класс недоступен с компилятором bcc5.5.

См. также QAxScriptEngine, QAxScriptManager, QAxBase и Фреймворк ActiveQt.

Документация по типам членов

перечисление QAxScript::FunctionFlags

Это перечисление FunctionFlags описывает формат для интроспекции функций.

Документация по функциям-членам

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

Конструирует объект QAxScript с именем name и регистрирует его в QAxScriptManager manager. Это обычно выполняется классом QAxScriptManager при загрузке сценария.

Сценарий всегда должен иметь имя. Менеджер необходим, чтобы код сценария мог ссылаться на объекты в приложении. Менеджер manager принимает владение объектом.

[override virtual] QAxScript::~QAxScript()

Уничтожает объект, освобождая все выделенные ресурсы.

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())

Вызывает функцию function, передавая параметры var1, var1, var2, var3, var4, var5, var6, var7 и var8 в качестве аргументов и возвращает значение, возвращаемое функцией, или недействительный QVariant, если функция не возвращает значение или вызов функции не удался.

См. QAxScriptManager::call() для получения дополнительной информации о вызове функций сценария.

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

Это перегруженная функция.

Вызывает функцию function, передавая arguments в качестве параметров, и возвращает результат. Возвращается, когда выполнение сценария завершено.

См. QAxScriptManager::call() для получения дополнительной информации о вызове функций сценария.

[signal] void QAxScript::entered()

Этот сигнал излучается, когда движок сценария начинает выполнение кода.

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

Этот сигнал излучается, когда во время выполнения сценария произошла ошибка выполнения.

code, description, sourcePosition и sourceText содержат информацию об ошибке выполнения.

[signal] void QAxScript::finished()

Этот сигнал излучается, когда движок сценария завершил выполнение кода.

Примечание: Сигнал finished перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя на функцию Qt предоставляет удобную вспомогательную функцию для получения указателя на функцию, как показано в этом примере:

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

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

Это перегруженный метод.

result содержит результат выполнения скрипта. Это будет невалидное значение QVariant, если скрипт не возвращает никакого значения.

Примечание: Сигнал finished перегружен в этом классе. Для подключения к этому сигналу с использованием синтаксиса указателей на функции Qt предоставляет удобную вспомогательную функцию для получения указателя на функцию, как показано в этом примере:

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)

Это перегруженный метод.

code, source, description и help содержат информацию об ошибке при завершении выполнения скрипта.

Примечание: Сигнал finished перегружен в этом классе. Для подключения к этому сигналу с использованием синтаксиса указателей на функции Qt предоставляет удобную вспомогательную функцию для получения указателя на функцию, как показано в этом примере:

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 flags = FunctionNames) const

Возвращает список всех функций в этом скрипте, если соответствующий движок скриптов поддерживает интроспекцию; в противном случае возвращает пустой список. Функции предоставляются либо с полными прототипами, либо только с именами, в зависимости от значения flags.

См. также QAxScriptEngine::hasIntrospection().

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

Загружает исходный код скрипта code на языке language в движок скриптов. Возвращает true, если code был успешно загружен в движок скриптов; в противном случае возвращает false.

Если language пустое (по умолчанию), оно будет определено эвристически. Если code содержит строку End Sub , она будет интерпретирована как VBScript, в противном случае как JScript. Дополнительные языки скриптов могут быть зарегистрированы с помощью QAxScriptManager::registerEngine().

Эта функция может быть вызвана только один раз для каждого объекта QAxScript, что происходит автоматически при использовании QAxScriptManager::load().

QString QAxScript::scriptCode() const

Возвращает код скрипта или пустую строку, если код еще не загружен.

См. также load().

QAxScriptEngine *QAxScript::scriptEngine() const

Возвращает указатель на движок скриптов.

Вы можете использовать полученный объект для подключения сигналов к функциям скрипта или для прямого доступа к движку скриптов.

QString QAxScript::scriptName() const

Возвращает имя скрипта.

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

Этот сигнал излучается, когда движок скриптов изменяет состояние. state может принимать любое значение из перечисления QAxScriptEngine::State.