Spec-Zone.ru › Qt 5.15

Класс QImageIOPlugin

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

Заголовок: #include <QImageIOPlugin>
qmake: QT += gui
Наследуется от: QObject
  • Список всех членов, включая унаследованные члены

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

Открытые типы

флаги Возможности
перечисление Возможность { МожноЧитать, МожноЗаписывать, МожноЧитатьИнкрементально }

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

QImageIOPlugin(QObject *parent = nullptr)
виртуальный ~QImageIOPlugin()
виртуальный QImageIOPlugin::Возможности возможности(QIODevice *device, const QByteArray &format) const = 0
виртуальный QImageIOHandler * создать(QIODevice *device, const QByteArray &format = QByteArray()) const = 0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

QImageIOPlugin::QImageIOPlugin(QObject *parent = nullptr)

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

[virtual] QImageIOPlugin::~QImageIOPlugin()

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

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

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

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

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

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

[pure virtual] QImageIOHandler *QImageIOPlugin::создать(QIODevice *device, const QByteArray &format = QByteArray()) const

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

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

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.15/qimageioplugin.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API