Класс QPluginLoader

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

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

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

Свойства

• fileName : QString
• loadHints : QLibrary::LoadHints

• 1 свойство унаследовано от QObject

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

• 32 открытых функции унаследованы от QObject

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

• 11 статических открытых членов унаследованы от QObject

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

Дополнительные унаследованные члены

• 1 открытый слот унаследован от QObject
• 2 сигналы унаследованы от QObject
• 9 защищенных функций унаследованы от QObject

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

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

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(QObject *parent = Q_NULLPTR)

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

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

Создаёт загрузчик плагинов с заданным parent, который будет загружать плагин, заданный fileName.

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

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

QPluginLoader::~QPluginLoader()

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

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

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

QString QPluginLoader::errorString() const

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

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

QObject *QPluginLoader::instance()

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

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

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