Класс QImageIOHandler
Класс QImageIOHandler определяет общий интерфейс ввода-вывода изображений для всех форматов изображений в Qt. Подробнее...
| Заголовок: | #include <QImageIOHandler> |
| CMake: | find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
Примечание: Все функции в этом классе являются повторно входящими.
Типы публичного доступа
| Перечисление | ImageOption { Size, ClipRect, ScaledSize, ScaledClipRect, Description, …, ImageTransformation } |
| Перечисление | Transformation { TransformationNone, TransformationMirror, TransformationFlip, TransformationRotate180, TransformationRotate90, …, TransformationRotate270 } |
| Флаги | Transformations |
Функции публичного доступа
| QImageIOHandler() | |
| virtual | ~QImageIOHandler() |
| virtual bool | canRead() const = 0 |
| virtual int | currentImageNumber() const |
| virtual QRect | currentImageRect() const |
| QIODevice * | device() const |
| QByteArray | format() const |
| virtual int | imageCount() const |
| virtual bool | jumpToImage(int imageNumber) |
| virtual bool | jumpToNextImage() |
| virtual int | loopCount() const |
| virtual int | nextImageDelay() const |
| virtual QVariant | option(QImageIOHandler::ImageOption option) const |
| virtual bool | read(QImage *image) = 0 |
| void | setDevice(QIODevice *device) |
| void | setFormat(const QByteArray &format) |
| void | setFormat(const QByteArray &format) const |
| virtual void | setOption(QImageIOHandler::ImageOption option, const QVariant &value) |
| virtual bool | supportsOption(QImageIOHandler::ImageOption option) const |
| virtual bool | write(const QImage &image) |
Статические члены публичного доступа
| bool | allocateImage(QSize size, QImage::Format format, 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 (область интереса). Обработчик, поддерживающий этот параметр, должен считывать только заданную область QRect из исходного изображения в read() перед применением любых других преобразований. |
QImageIOHandler::ScaledSize |
4 |
Масштабированный размер изображения. Обработчик, поддерживающий этот параметр, должен масштабировать изображение до заданного размера (a QSize) после применения преобразования обрезки (ClipRect). Если обработчик не поддерживает этот параметр, QImageReader выполнит масштабирование после чтения изображения. |
QImageIOHandler::ScaledClipRect |
3 |
Масштабированный прямоугольник обрезки (или ROI, область интереса) изображения. Обработчик, поддерживающий этот параметр, должен применить заданный прямоугольник обрезки (a 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, инициализирует цвет фона этим значением (a QColor) при чтении изображения. |
QImageIOHandler::ImageFormat |
14 |
Формат данных изображения, возвращаемый обработчиком. Это может быть любой из форматов, перечисленных в QImage::Format. |
QImageIOHandler::SupportedSubTypes |
15 |
Форматы изображений, которые поддерживают различные варианты сохранения, должны возвращать список поддерживаемых имен вариантов (QList<QByteArray>) в этом параметре. |
QImageIOHandler::OptimizedWrite |
16 |
. Обработчик, который поддерживает этот параметр, должен включить флаги оптимизации при записи. |
QImageIOHandler::ProgressiveScanWrite |
17 |
. Обработчик, который поддерживает этот параметр, должен записать изображение как изображение с прогрессивной разверткой. |
QImageIOHandler::ImageTransformation |
18 |
. Обработчик, который поддерживает этот параметр, может прочитать метаданные преобразования изображения. Обработчик, который поддерживает этот параметр, не должен применять преобразование сам. |
[since 5.5] перечисление 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.
[static, since 6.0] bool QImageIOHandler::allocateImage(QSize size, QImage::Format format, QImage *image)
Это удобный метод для функции чтения в подклассах. Обработчики форматов изображений должны отклонять загрузку изображения, если требуемая выделение превысит текущий лимит выделения. Эта функция проверяет параметры и лимит, и выполняет выделение, если оно допустимо и необходимо. При успешном возвращении image будет допустимым, отсоединённым QImage заданного размера size и формата format.
Эта функция была введена в Qt 6.0.
См. также QImageReader::allocationLimit().
[pure virtual] bool QImageIOHandler::canRead() const
Возвращает true , если изображение может быть прочитано из устройства (т.е. формат изображения поддерживается, устройство может быть прочитано, и информация из заголовка указывает, что изображение может быть прочитано); в противном случае возвращает false.
При переопределении canRead() убедитесь, что устройство ввода-вывода (device()) остаётся в исходном состоянии (например, используя peek() вместо read()).
См. также read() и QIODevice::peek().
[virtual] int QImageIOHandler::currentImageNumber() const
Для форматов изображений, поддерживающих анимацию, эта функция возвращает номер последовательности текущего изображения в анимации. Если эта функция вызывается до чтения любого изображения read(), возвращается -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-6.2/qimageiohandler.html
