Класс 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. Некоторые опции используются для запроса свойств изображения, а другие — для переключения способа записи изображения.

enum QImageIOHandler::Transformationflags QImageIOHandler::Transformations

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

Это перечисление было введено или изменено в Qt 5.5.

Тип Transformations является псевдонимом для QFlags<Transformation>. Он хранит комбинацию значений Transformation с помощью оператора OR.

См. также 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

Для форматов изображений, поддерживающих анимацию, эта функция возвращает порядковый номер текущего изображения в анимации. Если эта функция вызывается до чтения любого изображения с помощью read(), возвращается -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(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.