Класс QImageIOHandler
Класс QImageIOHandler определяет общий интерфейс ввода/вывода изображений для всех форматов изображений в Qt. Подробнее...
| Заголовок: | #include <QImageIOHandler> |
| qmake: | QT += gui |
Примечание: Все функции в этом классе являются реентерабельными.
Типы публичного доступа
| Перечисление | ImageOption { Size, ClipRect, ScaledSize, ScaledClipRect, ..., TransformedByDefault } |
| Перечисление | Transformation { TransformationNone, TransformationMirror, TransformationFlip, TransformationRotate180, ..., TransformationRotate270 } |
| Флаги | Transformations |
Функции публичного доступа
| QImageIOHandler() | |
| виртуальный | ~QImageIOHandler() |
| виртуальный bool | canRead() const = 0 |
| виртуальный int | currentImageNumber() const |
| виртуальный QRect | currentImageRect() const |
| QIODevice * | device() const |
| QByteArray | format() const |
| виртуальный int | imageCount() const |
| виртуальный bool | jumpToImage(int imageNumber) |
| виртуальный bool | jumpToNextImage() |
| виртуальный int | loopCount() const |
| виртуальный int | nextImageDelay() const |
| виртуальный QVariant | option(ImageOption option) const |
| виртуальный bool | read(QImage *image) = 0 |
| void | setDevice(QIODevice *device) |
| void | setFormat(const QByteArray &format) |
| void | setFormat(const QByteArray &format) const |
| виртуальный void | setOption(ImageOption option, const QVariant &value) |
| виртуальный bool | supportsOption(ImageOption option) const |
| виртуальный bool | write(const QImage &image) |
Подробное описание
Класс QImageIOHandler определяет общий интерфейс ввода/вывода изображений для всех форматов изображений в Qt.
Qt использует QImageIOHandler для чтения и записи изображений через QImageReader и QImageWriter. Вы также можете унаследовать от этого класса, чтобы написать свой собственный обработчик форматов изображений, используя механизм плагинов Qt.
Вызовите setDevice(), чтобы назначить устройство обработчику, и setFormat(), чтобы назначить формат. Один QImageIOHandler может поддерживать более одного формата изображения. canRead() возвращает true , если изображение может быть прочитано из устройства, а read() и write() возвращают true, если чтение или запись изображения завершились успешно.
QImageIOHandler также поддерживает форматы анимации через функции loopCount(), imageCount(), nextImageDelay() и currentImageNumber().
Для определения поддерживаемых обработчиком изображений параметров Qt будет вызывать supportsOption() и setOption(). Убедитесь, что переопределяете эти функции, если вы можете предоставить поддержку любого из параметров в перечислении ImageOption.
Для написания собственного обработчика изображений вы должны как минимум переопределить canRead() и read(). Затем создайте QImageIOPlugin, который может создать обработчик. Наконец, установите свой плагин, и QImageReader и QImageWriter автоматически загрузит плагин и начнут его использовать.
См. также QImageIOPlugin, QImageReader и QImageWriter.
Документация по типам членов
Перечисление QImageIOHandler::ImageOption
Это перечисление описывает различные параметры, поддерживаемые QImageIOHandler. Некоторые параметры используются для запроса свойств изображения, а другие используются для переключения способа записи изображения.
| Константа | Значение | Описание |
|---|---|---|
QImageIOHandler::Size |
0 |
Исходный размер изображения. Обработчик, поддерживающий этот параметр, должен считывать размер изображения из метаданных изображения и возвращать этот размер из option() в виде QSize. |
QImageIOHandler::ClipRect |
1 |
Прямоугольник обрезки или ROI (Region Of Interest). Обработчик, поддерживающий этот параметр, должен считывать только указанную область QRect из исходного изображения в read() до применения любых других преобразований. |
QImageIOHandler::ScaledSize |
4 |
Масштабированный размер изображения. Обработчик, поддерживающий этот параметр, должен масштабировать изображение до заданного размера (a QSize) после применения любого преобразования обрезки (ClipRect). Если обработчик не поддерживает этот параметр, QImageReader выполнит масштабирование после чтения изображения. |
QImageIOHandler::ScaledClipRect |
3 |
Масштабированный прямоугольник обрезки (или ROI, Region Of Interest) изображения. Обработчик, поддерживающий этот параметр, должен применить заданный прямоугольник обрезки (a QRect) после применения любого масштабирования (ScaleSize) или обычной обрезки (ClipRect). Если обработчик не поддерживает этот параметр, QImageReader применит масштабированный прямоугольник обрезки после чтения изображения. |
QImageIOHandler::Description |
2 |
Описание изображения. Некоторые форматы изображений, такие как GIF и PNG, позволяют встраивать текст или комментарии в данные изображения (например, для хранения информации об авторских правах). Часто текст хранится в парах ключ-значение, но некоторые форматы хранят весь текст в одном непрерывном блоке. QImageIOHandler возвращает текст как один QString, где ключи и значения разделены двоеточием, а пары ключ-значение разделены двумя переводами строк (\n\n). Например, «Заголовок: Закат\n\nАвтор: Иван Иванов\nМария Иванова\n\n». Форматы, которые хранят текст в одном блоке, могут использовать «Описание» в качестве ключа. |
QImageIOHandler::CompressionRatio |
5 |
Коэффициент сжатия данных изображения. Обработчик, поддерживающий этот параметр, должен установить коэффициент сжатия в зависимости от значения этого параметра (int) при записи. |
QImageIOHandler::Gamma |
6 |
Уровень гаммы изображения. Обработчик, поддерживающий этот параметр, должен установить уровень гаммы изображения в зависимости от значения этого параметра (float) при записи. |
QImageIOHandler::Quality |
7 |
Уровень качества изображения. Обработчик, поддерживающий этот параметр, должен установить уровень качества изображения в зависимости от значения этого параметра (int) при записи. |
QImageIOHandler::Name |
8 |
Название изображения. Обработчик, поддерживающий этот параметр, должен считывать имя из метаданных изображения и возвращать его как QString, или при записи изображения он должен хранить имя в метаданных изображения. |
QImageIOHandler::SubType |
9 |
Подтип изображения. Обработчик, поддерживающий этот параметр, может использовать значение подтипа для помощи при чтении и записи изображений. Например, обработчик PPM может иметь значение подтипа «ppm» или «ppmraw». |
QImageIOHandler::IncrementalReading |
10 |
Обработчик, поддерживающий этот параметр, должен считывать изображение в несколько проходов, как если бы это была анимация. QImageReader будет обрабатывать изображение как анимацию. |
QImageIOHandler::Endianness |
11 |
Порядок байтов (Endianness) изображения. Некоторые форматы изображений могут храниться как BigEndian или LittleEndian. Обработчик, поддерживающий порядок байтов, использует значение этого параметра, чтобы определить, как изображение должно быть сохранено. |
QImageIOHandler::Animation |
12 |
Форматы изображений, поддерживающие анимацию, возвращают true для этого значения в supportsOption(); в противном случае возвращается false. |
QImageIOHandler::BackgroundColor |
13 |
Некоторые форматы изображений позволяют указать цвет фона. Обработчик, поддерживающий BackgroundColor, инициализирует цвет фона этим параметром (a QColor) при чтении изображения. |
QImageIOHandler::ImageFormat |
14 |
Формат данных изображения, возвращаемый обработчиком. Он может быть любым из форматов, перечисленных в QImage::Format. |
QImageIOHandler::SupportedSubTypes |
15 |
Форматы изображений, которые поддерживают различные варианты сохранения, должны возвращать список имен поддерживаемых вариантов (QList<QByteArray>) в этом параметре. |
QImageIOHandler::OptimizedWrite |
16 |
Обработчик, поддерживающий этот параметр, должен включить флаги оптимизации при записи. |
QImageIOHandler::ProgressiveScanWrite |
17 |
Обработчик, поддерживающий этот параметр, должен записать изображение как изображение с прогрессивной разверткой. |
QImageIOHandler::ImageTransformation |
18 |
Обработчик, поддерживающий этот параметр, может прочитать метаданные преобразований изображения. Обработчик, поддерживающий этот параметр, не должен применять преобразование самостоятельно. |
QImageIOHandler::TransformedByDefault |
19 |
Обработчик, сообщающий о поддержке этой функции, по умолчанию будет применять метаданные преобразования изображения при чтении. |
перечисление QImageIOHandler::Transformationфлаги QImageIOHandler::Transformations
Это перечисление описывает различные преобразования или ориентации, поддерживаемые некоторыми форматами изображений, обычно через EXIF.
| Константа | Значение | Описание |
|---|---|---|
QImageIOHandler::TransformationNone |
0 |
Преобразование не должно применяться. |
QImageIOHandler::TransformationMirror |
1 |
Отразить изображение по горизонтали. |
QImageIOHandler::TransformationFlip |
2 |
Отразить изображение по вертикали. |
QImageIOHandler::TransformationRotate180 |
TransformationMirror | TransformationFlip |
Повернуть изображение на 180 градусов. Это то же самое, что отразить его по горизонтали и вертикали. |
QImageIOHandler::TransformationRotate90 |
4 |
Повернуть изображение на 90 градусов. |
QImageIOHandler::TransformationMirrorAndRotate90 |
TransformationMirror | TransformationRotate90 |
Отразить изображение по горизонтали, а затем повернуть на 90 градусов. |
QImageIOHandler::TransformationFlipAndRotate90 |
TransformationFlip | TransformationRotate90 |
Отразить изображение по вертикали, а затем повернуть на 90 градусов. |
QImageIOHandler::TransformationRotate270 |
TransformationRotate180 | TransformationRotate90 |
Повернуть изображение на 270 градусов. Это то же самое, что отразить его по горизонтали, вертикали и затем повернуть на 90 градусов. |
Это перечисление было введено или изменено в Qt 5.5.
Тип Transformations является псевдонимом для QFlags<Transformation>. Он хранит логическое ИЛИ комбинацию значений Transformation.
См. такжеQImageReader::transformation(), QImageReader::setAutoTransform(), и QImageWriter::setTransformation().
Документация по функциям-членам
QImageIOHandler::QImageIOHandler()
Конструирует объект QImageIOHandler.
[virtual] QImageIOHandler::~QImageIOHandler()
Деструктор объекта QImageIOHandler.
[pure virtual] bool QImageIOHandler::canRead() const
Возвращает true если изображение может быть прочитано из устройства (т.е. формат изображения поддерживается, устройство может быть прочитано, и начальная информация заголовка предполагает, что изображение может быть прочитано); в противном случае возвращает false.
При переопределении canRead() убедитесь, что устройство ввода/вывода (device()) остается в исходном состоянии (например, используя peek() вместо read()).
См. также read() и QIODevice::peek().
[virtual] int QImageIOHandler::currentImageNumber() const
Для форматов изображений, которые поддерживают анимацию, эта функция возвращает номер последовательности текущего изображения в анимации. Если эта функция вызывается до чтения любого изображения, возвращается -1. Номер первого изображения в последовательности — 0.
Если формат изображения не поддерживает анимацию, возвращается 0.
См. также read().
[virtual] QRect QImageIOHandler::currentImageRect() const
Возвращает прямоугольник текущего изображения. Если для изображения прямоугольник не определён, возвращается пустой QRect().
Эта функция полезна для анимаций, когда только части кадра могут обновляться за раз.
QIODevice *QImageIOHandler::device() const
Возвращает устройство, текущее назначенное обработчику изображений QImageIOHandler. Если устройство не было назначено, возвращается 0.
См. также setDevice().
QByteArray QImageIOHandler::format() const
Возвращает формат, текущее назначенный обработчику изображений QImageIOHandler. Если формат не был назначен, возвращается пустая строка.
См. также setFormat().
[virtual] int QImageIOHandler::imageCount() const
Для форматов изображений, поддерживающих анимацию, эта функция возвращает количество изображений в анимации. Если формат изображения не поддерживает анимацию или не может определить количество изображений, возвращается 0.
Реализация по умолчанию возвращает 1, если canRead() возвращает true; в противном случае возвращается 0.
[virtual] bool QImageIOHandler::jumpToImage(int imageNumber)
Для форматов изображений, поддерживающих анимацию, эта функция переходит к изображению с номером последовательности imageNumber. Следующий вызов read() будет пытаться прочитать это изображение.
Реализация по умолчанию ничего не делает и возвращает false.
[virtual] bool QImageIOHandler::jumpToNextImage()
Для форматов изображений, поддерживающих анимацию, эта функция переходит к следующему изображению.
Реализация по умолчанию ничего не делает и возвращает false.
[virtual] int QImageIOHandler::loopCount() const
Для форматов изображений, поддерживающих анимацию, эта функция возвращает количество раз, которое должна повторяться анимация. Если формат изображения не поддерживает анимацию, возвращается 0.
[virtual] int QImageIOHandler::nextImageDelay() const
Для форматов изображений, поддерживающих анимацию, эта функция возвращает количество миллисекунд, которое нужно подождать, прежде чем читать следующее изображение. Если формат изображения не поддерживает анимацию, возвращается 0.
[virtual] QVariant QImageIOHandler::option(ImageOption option) const
Возвращает значение, назначенное для option, как QVariant. Тип значения зависит от параметра. Например, option(Size) возвращает QSize вариант.
См. также setOption() и supportsOption().
[pure virtual] bool QImageIOHandler::read(QImage *image)
Читает изображение из устройства и сохраняет его в image. Возвращает true если изображение успешно прочитано; в противном случае возвращает false.
Для форматов изображений, которые поддерживают инкрементальную загрузку, и для форматов анимации, обработчик изображений может предполагать, что image указывает на предыдущий кадр.
См. также canRead().
void QImageIOHandler::setDevice(QIODevice *device)
Устанавливает устройство обработчика изображений QImageIOHandler на device. Обработчик изображений будет использовать это устройство при чтении и записи изображений.
Устройство может быть установлено только один раз и должно быть установлено перед вызовом canRead(), read(), write() и т.д. Если вам нужно читать несколько файлов, создайте несколько экземпляров соответствующего подкласса QImageIOHandler.
См. также device().
void QImageIOHandler::setFormat(const QByteArray &format)
Устанавливает формат обработчика изображений QImageIOHandler на format. Формат наиболее полезен для обработчиков, которые поддерживают несколько форматов изображений.
См. также format().
void QImageIOHandler::setFormat(const QByteArray &format) const
Устанавливает формат обработчика изображений QImageIOHandler на format. Формат наиболее полезен для обработчиков, которые поддерживают несколько форматов изображений.
Эта функция объявлена const, чтобы её можно было вызывать из canRead().
См. также format().
[virtual] void QImageIOHandler::setOption(ImageOption option, const QVariant &value)
Устанавливает параметр option со значением value.
См. также option() и ImageOption.
[virtual] bool QImageIOHandler::supportsOption(ImageOption option) const
Возвращает true если обработчик изображений QImageIOHandler поддерживает параметр option; в противном случае возвращает false. Например, если обработчик изображений QImageIOHandler поддерживает параметр Size, supportsOption(Size) должен возвращать true.
См. также setOption() и option().
[virtual] bool QImageIOHandler::write(const QImage &image)
Записывает изображение image в назначенное устройство. Возвращает true при успехе; в противном случае возвращает false.
Реализация по умолчанию ничего не делает и просто возвращает false.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qimageiohandler.html
