Класс QImageIOPlugin

Класс QImageIOPlugin определяет интерфейс для написания плагина формата изображения. Подробнее...

Заголовок:	#include <QImageIOPlugin>
CMake:	find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake:	QT += gui
Наследует:	QObject

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

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

Типы public

флаги	Возможности
перечисление	Возможность { CanRead, CanWrite, CanReadIncremental }

Public-функции

	QImageIOPlugin(QObject *parent = nullptr)
virtual	~QImageIOPlugin()
virtual QImageIOPlugin::Возможности	capabilities(QIODevice *device, const QByteArray &format) const = 0
virtual QImageIOHandler *	create(QIODevice *device, const QByteArray &format = QByteArray()) const = 0

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

QImageIOPlugin — это фабрика для создания объектов QImageIOHandler, которые используются внутри QImageReader и QImageWriter для добавления поддержки различных форматов изображений в Qt.

Написание плагина ввода/вывода изображений достигается путем наследования от этого базового класса, переопределения чистых виртуальных функций capabilities() и create() и экспорта класса с помощью макроса Q_PLUGIN_METADATA(). Подробности см. в разделе Как создать плагины Qt.

Плагин формата изображения может поддерживать три возможности: чтение (CanRead), запись (CanWrite) и инкрементальное чтение (CanReadIncremental). Переопределите capabilities() в своем подклассе, чтобы экспонировать возможности вашего формата изображения.

create() должен создать экземпляр вашего подкласса QImageIOHandler с правильно заданными устройством и форматом и вернуть этот обработчик.

Файл метаданных json для плагина должен содержать информацию о форматах изображений, которые поддерживает плагин, вместе с соответствующими MIME-типами (по одному для каждого формата). Например, для плагина jpeg это может выглядеть следующим образом:

{
  "Keys": [ "jpg", "jpeg" ],
  "MimeTypes": [ "image/jpeg", "image/jpeg" ]
}

Различные плагины могут поддерживать разные возможности. Например, у вас может быть один плагин, который поддерживает чтение формата GIF, и другой, который поддерживает запись. Qt выберет правильный плагин для задачи в зависимости от возвращаемого значения capabilities(). Если несколько плагинов поддерживают одну и ту же возможность, Qt произвольно выберет один из них.

См. также QImageIOHandler и Как создать плагины Qt.

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

перечисление QImageIOPlugin::Возможностьфлаги QImageIOPlugin::Возможности

Это перечисление описывает возможности QImageIOPlugin.

Постоянная	Значение	Описание
`QImageIOPlugin::CanRead`	`0x1`	Плагин может читать изображения.
`QImageIOPlugin::CanWrite`	`0x2`	Плагин может записывать изображения.
`QImageIOPlugin::CanReadIncremental`	`0x4`	Плагин может читать изображения инкрементально.

Тип Возможности — это typedef для QFlags<Возможность>. Он хранит результат логической операции OR значений Возможность.

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

QImageIOPlugin::QImageIOPlugin(QObject **parent* = nullptr)

Создает плагин изображения с заданным parent. Это вызывается автоматически сгенерированным moc-кодом, экспортирующим плагин.

`[virtual]` QImageIOPlugin::~QImageIOPlugin()

Уничтожает плагин формата изображения.

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

`[pure virtual]` QImageIOPlugin::Возможности QImageIOPlugin::capabilities(QIODevice **device, const QByteArray &format*) const

Возвращает возможности плагина на основе данных в device и формате format. Если device пуст, следует просто сообщить, может ли формат читаться или записываться. В противном случае следует попытаться определить, может ли указанный формат (или любой формат, поддерживаемый плагином, если format пустой) читаться или записываться в device. Это должно выполняться без изменения состояния device (обычно с помощью QIODevice::peek()).

Например, если QImageIOPlugin поддерживает формат BMP, format пуст или "bmp", а данные в устройстве начинаются с символов "BM", эта функция должна вернуть CanRead. Если format пуст, device пуст и обработчик поддерживает как чтение, так и запись, эта функция должна вернуть CanRead | CanWrite.

Имена форматов всегда задаются строчными буквами.

`[pure virtual]` QImageIOHandler *QImageIOPlugin::create(QIODevice **device, const QByteArray &format* = QByteArray()) const

Создает и возвращает подкласс QImageIOHandler с заданными device и format. format должен быть взят из значений, перечисленных в записи "Keys" в метаданных плагина или быть пустым. Если он пуст, данные в device должны быть распознаны методом capabilities() (с аналогично пустым форматом).