Класс QImageIOHandler

Класс QImageIOHandler определяет общий интерфейс ввода/вывода изображений для всех форматов изображений в Qt. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

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

Типы публичного доступа

Функции публичного доступа

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

Класс 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::Transformationфлаги QImageIOHandler::Transformations

Это перечисление описывает различные преобразования или ориентации, поддерживаемые некоторыми форматами изображений, обычно через EXIF.

Это перечисление было введено или изменено в 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.