Класс QAxScript
Класс QAxScript предоставляет оболочку для скриптового кода. Подробнее...
| Заголовок: | #include <QAxScript> |
| qmake: | QT += axcontainer |
| Наследуется от: | QObject |
Типы публичного доступа
| перечисление | FunctionFlags { FunctionNames, FunctionSignatures } |
Функции публичного доступа
| QAxScript(const QString &name, QAxScriptManager *manager) | |
| виртуальный | ~QAxScript() |
| 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 |
- 34 функции публичного доступа, унаследованные от QObject
Сигналы
| 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) |
- 2 сигнала, унаследованные от QObject
Дополнительные унаследованные члены
- 1 свойство, унаследованное от QObject
- 1 слот публичного доступа, унаследованный от QObject
- 1 переменная публичного доступа, унаследованная от QObject
- 10 статические члены публичного доступа, унаследованные от QObject
- 9 защищённые функции, унаследованные от QObject
- 2 защищённые переменные, унаследованные от QObject
Подробное описание
Класс QAxScript предоставляет оболочку для скриптового кода.
Каждый экземпляр класса QAxScript представляет собой фрагмент скриптового кода на определённом языке программирования. Код загружается в движок скриптов с помощью load(). Объявленные в коде функции могут быть вызваны с помощью call().
Скрипт предоставляет обратную связь приложению через сигналы. Наиболее важным сигналом является error(). Прямой доступ к QAxScriptEngine предоставляется через функцию scriptEngine().
Предупреждение: Этот класс недоступен с компилятором bcc5.5.
См. также QAxScriptEngine, QAxScriptManager, QAxBase и Фреймворк ActiveQt.
Документация по типам членов
перечисление QAxScript::FunctionFlags
Это перечисление FunctionFlags описывает формат для интроспекции функций.
| Константа | Значение | Описание |
|---|---|---|
QAxScript::FunctionNames |
0 |
Возвращаются только имена функций. |
QAxScript::FunctionSignatures |
1 |
Возвращаются функции со спецификациями. |
Документация по функциям-членам
QAxScript::QAxScript(const QString &name, QAxScriptManager *manager)
Создаёт объект QAxScript с именем name и регистрирует его в QAxScriptManager manager. Это обычно выполняет класс QAxScriptManager при загрузке скрипта.
Скрипт должен всегда иметь имя. Менеджер необходим для ссылки на объекты в приложении. manager принимает владение объектом.
[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.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/archives/qt-5.11/qaxscript.html