Класс QImageIOHandler
Класс QImageIOHandler определяет общий интерфейс ввода-вывода изображений для всех форматов изображений в Qt. Подробнее...
| Заголовок: | #include <QImageIOHandler> |
| qmake: | QT += gui |
Примечание: Все функции в этом классе являются перевходовыми.
Общедоступные типы
| перечисление | ImageOption { Size, ClipRect, ScaledSize, ScaledClipRect, Description, …, TransformedByDefault } |
| перечисление | Transformation { TransformationNone, TransformationMirror, TransformationFlip, TransformationRotate180, TransformationRotate90, …, 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(QImageIOHandler::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(QImageIOHandler::ImageOption option, const QVariant &value) |
| виртуальный bool | supportsOption(QImageIOHandler::ImageOption option) const |
| виртуальный bool | write(const QImage &image) |
Подробное описание
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 |
Масштабированный размер изображения. Обработчик, поддерживающий этот параметр, должен масштабировать изображение до указанного размера (QSize) после применения любого преобразования обрезки (ClipRect). Если обработчик не поддерживает этот параметр, QImageReader выполнит масштабирование после чтения изображения. |
QImageIOHandler::ScaledClipRect |
3 |
Масштабированный прямоугольник обрезки (или ROI, Region Of Interest) изображения. Обработчик, поддерживающий этот параметр, должен применить указанный прямоугольник обрезки (QRect) после применения любого масштабирования (ScaleSize) или обычной обрезки (ClipRect). Если обработчик не поддерживает этот параметр, QImageReader применит масштабированный прямоугольник обрезки после чтения изображения. |
QImageIOHandler::Description |
2 |
Описание изображения. Некоторые форматы изображений, такие как GIF и PNG, позволяют встраивать текст или комментарии в данные изображения (например, для хранения информации об авторских правах). Часто текст хранится в виде пар «ключ-значение», но некоторые форматы хранят весь текст в одном непрерывном блоке. QImageIOHandler возвращает текст как одну QString, где ключи и значения разделены двоеточием, а пары «ключ-значение» разделены двумя новыми строками (\n\n). Например, «Title: Sunset\n\nAuthor: Jim Smith\nSarah Jones\n\n». Форматы, которые хранят текст в одном блоке, могут использовать «Description» в качестве ключа. |
QImageIOHandler::CompressionRatio |
5 |
Коэффициент сжатия данных изображения. Обработчик, поддерживающий этот параметр, должен устанавливать коэффициент сжатия в зависимости от значения этого параметра (целое число) при записи. |
QImageIOHandler::Gamma |
6 |
Уровень гамма-коррекции изображения. Обработчик, поддерживающий этот параметр, должен установить уровень гамма-коррекции изображения в зависимости от значения этого параметра (число с плавающей точкой) при записи. |
QImageIOHandler::Quality |
7 |
Уровень качества изображения. Обработчик, поддерживающий этот параметр, должен установить уровень качества изображения в зависимости от значения этого параметра (целое число) при записи. |
QImageIOHandler::Name |
8 |
Имя изображения. Обработчик, поддерживающий этот параметр, должен считывать имя из метаданных изображения и возвращать его как QString, или при записи изображения он должен хранить имя в метаданных изображения. |
QImageIOHandler::SubType |
9 |
Подтип изображения. Обработчик, поддерживающий этот параметр, может использовать значение подтипа для помощи при чтении и записи изображений. Например, обработчик PPM может иметь значение подтипа «ppm» или «ppmraw». |
QImageIOHandler::IncrementalReading |
10 |
Обработчик, поддерживающий этот параметр, должен считывать изображение несколькими проходами, как если бы это была анимация. QImageReader будет обрабатывать изображение как анимацию. |
QImageIOHandler::Endianness |
11 |
Порядок байтов изображения. Некоторые форматы изображений могут храниться как BigEndian или LittleEndian. Обработчик, поддерживающий порядок байтов, использует значение этого параметра для определения того, как должно храниться изображение. |
QImageIOHandler::Animation |
12 |
Форматы изображений, которые поддерживают анимацию, возвращают true для этого значения в supportsOption(); в противном случае возвращается false. |
QImageIOHandler::BackgroundColor |
13 |
Некоторые форматы изображений позволяют указать цвет фона. Обработчик, поддерживающий BackgroundColor, инициализирует цвет фона этим параметром (QColor) при чтении изображения. |
QImageIOHandler::ImageFormat |
14 |
Формат данных изображения, возвращаемый обработчиком. Он может быть любым из форматов, перечисленных в QImage::Format. |
QImageIOHandler::SupportedSubTypes |
15 |
Форматы изображений, которые поддерживают различные варианты сохранения, должны возвращать список поддерживаемых имён вариантов (QList<QByteArray>) в этом параметре. |
QImageIOHandler::OptimizedWrite |
16 |
Обработчик, который поддерживает этот параметр, должен включить флаги оптимизации при записи. |
QImageIOHandler::ProgressiveScanWrite |
17 |
Обработчик, который поддерживает этот параметр, должен записать изображение как изображение с прогрессивным сканированием. |
QImageIOHandler::ImageTransformation |
18 |
Обработчик, который поддерживает этот параметр, может читать метаданные преобразования изображения. Обработчик, поддерживающий этот параметр, не должен применять преобразование сам. |
QImageIOHandler::TransformedByDefault |
19 |
Обработчик, который сообщает о поддержке этой функции, будет применять метаданные преобразования изображения по умолчанию при чтении. |
перечисление QImageIOHandler::Transformationflags 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. Если устройство не назначено, возвращается nullptr.
См. также 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(QImageIOHandler::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(QImageIOHandler::ImageOption option, const QVariant &value)
Устанавливает опцию option со значением value.
См. также option() и ImageOption.
[virtual] bool QImageIOHandler::supportsOption(QImageIOHandler::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.15/qimageiohandler.html
