Класс QPluginLoader

Класс QPluginLoader загружает плагин во время выполнения. Подробнее...

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

Примечание: Все функции в этом классе являются реентерабельными.

Свойства

• fileName : QString
• loadHints : QLibrary::LoadHints

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

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

Связанные нечлены

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

QPluginLoader предоставляет доступ к плагину Qt. Плагин Qt хранится в динамической библиотеке (DLL) и предлагает следующие преимущества по сравнению с динамическими библиотеками, доступ к которым осуществляется с помощью QLibrary:

• QPluginLoader проверяет, что плагин скомпилирован с той же версией Qt, что и приложение.
• QPluginLoader предоставляет прямой доступ к корневому объекту компонента (instance()), вместо того, чтобы заставлять вас вручную разрешать C-функцию.

Экземпляр объекта QPluginLoader работает с одним файлом динамической библиотеки, который мы называем плагином. Он предоставляет доступ к функциональности плагина независимым от платформы способом. Чтобы указать, какой плагин загрузить, передайте имя файла в конструкторе или задайте его с помощью setFileName().

Наиболее важные функции — load() для динамической загрузки файла плагина, isLoaded() для проверки успешности загрузки и instance() для доступа к корневому компоненту в плагине. Функция instance() неявно пытается загрузить плагин, если он еще не загружен. Можно использовать несколько экземпляров QPluginLoader для доступа к одному физическому плагину.

После загрузки плагины остаются в памяти до тех пор, пока все экземпляры QPluginLoader не будут разгружены или пока приложение не завершит работу. Вы можете попытаться разгрузить плагин, используя unload(), но если другие экземпляры QPluginLoader используют ту же библиотеку, вызов не удастся, и разгрузка произойдет только тогда, когда каждый экземпляр вызовет unload(). Непосредственно перед разгрузкой корневой компонент также будет удален.

См. Как создать плагины Qt для получения дополнительной информации о том, как сделать ваше приложение расширяемым с помощью плагинов.

Обратите внимание, что QPluginLoader не может быть использован, если ваше приложение статически скомпилировано с Qt. В этом случае вам также необходимо статически скомпилировать плагины. Вы можете использовать QLibrary, если вам нужно загрузить динамические библиотеки в статически скомпилированном приложении.

См. также QLibrary и Пример Plug & Paint.

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

QPluginLoader::QPluginLoader(const QString &fileName, QObject *parent = nullptr)

Конструктор загрузчика плагинов с заданным parent, который загрузит плагин, указанный в fileName.

Для загрузки файл должен иметь расширение, соответствующее платформе, например .so на Unix, .dylib на macOS и iOS, и .dll на Windows. Расширение можно проверить с помощью QLibrary::isLibrary().

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

QPluginLoader::QPluginLoader(QObject *parent = nullptr)

Конструктор загрузчика плагинов с заданным parent.

[virtual] QPluginLoader::~QPluginLoader()

Удаляет объект QPluginLoader.

Если unload() не был явно вызван, плагин остается в памяти до завершения приложения.

См. также isLoaded() и unload().

QString QPluginLoader::errorString() const

Возвращает текстовую строку с описанием последней ошибки.

Эта функция была введена в Qt 4.2.

QObject *QPluginLoader::instance()

Возвращает корневой объект компонента плагина. Плагин загружается при необходимости. Функция возвращает nullptr если плагин не смог загрузиться или корневой объект компонента не смог быть создан.

Если корневой объект компонента был уничтожен, вызов этой функции создает новый экземпляр.

Корневой компонент, возвращаемый этой функцией, не удаляется при уничтожении QPluginLoader. Если вы хотите убедиться, что корневой компонент удален, вы должны вызвать unload(), как только вам больше не нужно обращаться к основному компоненту. Когда библиотека, наконец, будет выгружена, корневой компонент будет автоматически удален.

Объект компонента является QObject. Используйте qobject_cast(), чтобы получить доступ к интересующим вас интерфейсам.

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

bool QPluginLoader::isLoaded() const

Возвращает true если плагин загружен; в противном случае возвращает false.

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

bool QPluginLoader::load()

Загружает плагин и возвращает true если плагин был успешно загружен; в противном случае возвращает false. Поскольку instance() всегда вызывает эту функцию перед разрешением каких-либо символов, нет необходимости вызывать её явно. В некоторых ситуациях вам может потребоваться предварительная загрузка плагина, в этом случае вы будете использовать эту функцию.

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

QJsonObject QPluginLoader::metaData() const

Возвращает метаданные для этого плагина. Метаданные представляют собой данные, указанные в формате json с помощью макроса Q_PLUGIN_METADATA() при компиляции плагина.

Метаданные могут быть запрошены быстрым и недорогим способом, не загружая фактически плагин. Это позволяет, например, хранить возможности плагина в них и принимать решение о загрузке плагина, в зависимости от этих метаданных.

[static] QObjectList QPluginLoader::staticInstances()

Возвращает список статических экземпляров плагина (корневых компонентов), хранящихся в загрузчике плагинов.

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

[static] QVector<QStaticPlugin> QPluginLoader::staticPlugins()

Возвращает список QStaticPlugins, хранящихся в загрузчике плагинов. Функция похожа на staticInstances(), с добавлением того, что QStaticPlugin также содержит информацию о метаданных.

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

bool QPluginLoader::unload()

Выгружает плагин и возвращает true если плагин может быть выгружен; в противном случае возвращает false.

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

Если другие экземпляры QPluginLoader используют тот же плагин, вызов завершится неудачей, и выгрузка произойдет только тогда, когда каждый экземпляр вызовет unload().

Не пытайтесь удалить корневой компонент. Вместо этого полагайтесь на то, что unload() автоматически удалит его при необходимости.

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