Класс QAxScript

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

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

Типы public

Открытые функции

Сигналы

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

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

Скрипт предоставляет обратную связь приложению через сигналы. Наиболее важным сигналом является сигнал 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 принимает владение объектом.

[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

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

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

QAxScriptEngine *QAxScript::scriptEngine() const

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

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

QString QAxScript::scriptName() const

Возвращает имя сценария.