Класс QAxScriptManager

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

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

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

Сигналы

Статические открытые члены

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

QAxScriptManager действует как мост между объектами COM, встроенными в приложение Qt через QAxObject или QAxWidget, и скриптовыми языками, доступными с помощью технологий Windows Script, обычно JScript и VBScript.

Создайте один QAxScriptManager для каждого отдельного документа в вашем приложении и добавьте объекты COM, к которым скрипты должны получить доступ, используя addObject(). Затем load() исходные коды скриптов и вызывайте функции, используя call().

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

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

QAxScriptManager::QAxScriptManager(QObject *parent = nullptr)

Создаёт объект QAxScriptManager. parent передаётся в конструктор QObject.

Обычно для каждого документа в приложении создаётся один QAxScriptManager.

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

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

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

[override virtual] QAxScriptManager::~QAxScriptManager()

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

void QAxScriptManager::addObject(QAxBase *object)

Добавляет object в менеджер. Скрипты, обрабатываемые этим менеджером, могут получить доступ к объекту в коде, используя свойство objectName объекта.

Вы должны добавить все необходимые объекты перед загрузкой каких-либо скриптов.

void QAxScriptManager::addObject(QObject *object)

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

Добавляет оболочку COM для object в менеджер. object должен быть экспонирован как COM-объект с использованием функциональности модуля QAxServer. Приложения, использующие эту функцию, должны быть связаны с библиотекой qaxserver.

QVariant QAxScriptManager::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, если функция не возвращает значение или вызов функции завершился неудачей. Вызов возвращается, когда выполнение скрипта завершено.

В большинстве движков скриптов единственный поддерживаемый тип параметра — «const QVariant&», например, для вызова функции JavaScript

function setNumber(number)
{
    n = number;
}

используйте

QValueList args;
args << 5;
script->call("setNumber(const QVariant&)", args);

Как и с dynamicCall, параметры могут быть непосредственно встроены в строку функции.

script->call("setNumber(5)");

Однако это медленнее.

Функции, предоставляемые движками скриптов, которые не поддерживают интроспекцию, недоступны и должны вызываться непосредственно с помощью QAxScript::call() на соответствующем объекте script.

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

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

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

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

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

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

QAxScript *QAxScriptManager::load(const QString &code, const QString &name, const QString &language)

Загружает исходный код скрипта code с использованием движка сценариев для языка. К скрипту впоследствии можно обратиться по его имени, которое не должно быть пустым.

Функция возвращает указатель на скрипт для данного кода, если код был загружен успешно; в противном случае возвращает 0.

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

Вы должны добавить все необходимые объекты (используя addObject()) перед загрузкой каких-либо скриптов. Если код объявляет функцию, которая уже доступна (независимо от языка), первая функция перегружается и больше не может быть вызвана через call(); но она по-прежнему будет доступна при вызове её напрямую через script.

См. также addObject(), scriptNames() и functions().

QAxScript *QAxScriptManager::load(const QString &file, const QString &name)

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

Загружает исходный код из файла file. К скрипту впоследствии можно обратиться по его имени, которое не должно быть пустым.

Функция возвращает указатель на движок сценариев для кода в file, если file был загружен успешно; в противном случае возвращает 0.

Используемый движок сценариев определяется из расширения файла. По умолчанию файлы ".js" интерпретируются как файлы JScript, а файлы ".vbs" и ".dsm" — как VBScript. Дополнительные движки сценариев можно зарегистрировать с помощью registerEngine().

[static] bool QAxScriptManager::registerEngine(const QString &name, const QString &extension, const QString &code = QString())

Регистрирует движок сценариев с именем name и возвращает true, если движок был найден; в противном случае ничего не делает и возвращает false.

Движок сценариев будет использоваться при загрузке файлов с заданным расширением extension или при загрузке исходного кода, содержащего строку code.

QAxScript *QAxScriptManager::script(const QString &name) const

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

Вы можете использовать возвращённый указатель для прямого вызова функций через QAxScript::call(), для прямого доступа к движку сценариев или для удаления и, следовательно, разгрузки скрипта.

[static] QString QAxScriptManager::scriptFileFilter()

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

QStringList QAxScriptManager::scriptNames() const

Возвращает список имён всех скриптов.