Класс QAxScript

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

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

Типы public

Public функции

Сигналы

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

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

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

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

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

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

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

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

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

Создаёт объект QAxScript с именем name и регистрирует его в QAxScriptManager manager. Обычно это выполняет класс QAxScriptManager при загрузке скрипта.

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

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

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

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

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

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

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

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

[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() для получения дополнительной информации о вызове функций скрипта.

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

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

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

QAxScriptEngine *QAxScript::scriptEngine() const

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

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

QString QAxScript::scriptName() const

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