Класс QImageIOPlugin
Класс QImageIOPlugin определяет интерфейс для написания плагина формата изображения. Подробнее...
| Заголовок: | #include <QImageIOPlugin> |
| qmake: | QT += gui |
| Наследует: | QObject |
Примечание: Все функции в этом классе являются взаимоисключающими.
Открытые типы
| флаги | Возможности |
| перечисление | Возможность { МожноЧитать, МожноЗаписать, МожноЧитатьПоЧастям } |
Открытые функции
| QImageIOPlugin(QObject *parent = nullptr) | |
| virtual | ~QImageIOPlugin() |
| virtual QImageIOPlugin::Возможности | возможности(QIODevice *device, const QByteArray &format) const = 0 |
| virtual QImageIOHandler * | создать(QIODevice *device, const QByteArray &format = QByteArray()) const = 0 |
Подробное описание
QImageIOPlugin является фабрикой для создания объектов QImageIOHandler, которые используются внутри QImageReader и QImageWriter для добавления поддержки различных форматов изображений в Qt.
Написание плагина ввода-вывода изображений достигается путем наследования от этого базового класса, переопределения чистых виртуальных функций возможности() и создать(), и экспорта класса с помощью макроса Q_PLUGIN_METADATA(). Подробнее см. Как создать плагины Qt.
Плагин формата изображения может поддерживать три возможности: чтение (МожноЧитать), запись (МожноЗаписать) и чтение по частям (МожноЧитатьПоЧастям). Переопределите возможности() в своем подклассе, чтобы показать возможности вашего формата изображения.
создать() должен создать экземпляр вашего подкласса QImageIOHandler с заданными устройством и форматом, и вернуть этот обработчик.
Файл метаданных 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 является 0, он должен просто сообщить, может ли формат читаться или записываться. В противном случае он должен попытаться определить, может ли заданный формат (или любой формат, поддерживаемый плагином, если format пусто) читаться или записываться в device. Это должно происходить без изменения состояния device (как правило, используя QIODevice::peek()).
Например, если QImageIOPlugin поддерживает формат BMP, format пустой или "bmp", и данные в устройстве начинаются с символов "BM", эта функция должна вернуть МожноЧитать. Если format пустая, 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.14/qimageioplugin.html