Класс QImageIOPlugin

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

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

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

Типы публичного доступа

Функции публичного доступа

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

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

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

Плагин формата изображения может поддерживать три возможности: чтение (МожетЧитать), запись (МожетЗаписывать) и инкрементальное чтение (МожетЧитатьИнкрементально). Переопределите capabilities() в своем подклассе, чтобы раскрыть возможности вашего формата изображения.

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

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

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

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

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

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

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

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

Тип Возможности является псевдонимом для 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 равен 0, он должен просто сообщать, может ли формат читаться или записываться. В противном случае, он должен попытаться определить, может ли указанный формат (или любой формат, поддерживаемый плагином, если format пустой) читаться или записываться в device. Он должен делать это без изменения состояния device (обычно с помощью QIODevice::peek()).

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

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

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

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

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