Skip to content

PythonQt.Qt.QImageIOHandler

QImageIOHandler

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

Qt uses QImageIOHandler for reading and writing images through QImageReader and QImageWriter. You can also derive from this class to write your own image format handler using Qt's plugin mechanism.

Call setDevice() to assign a device to the handler, and setFormat() to assign a format to it. One QImageIOHandler may support more than one image format. canRead() returns true if an image can be read from the device, and read() and write() return true if reading or writing an image was completed successfully.

QImageIOHandler also has support for animations formats, through the functions loopCount(), imageCount(), nextImageDelay() and currentImageNumber().

In order to determine what options an image handler supports, Qt will call supportsOption() and setOption(). Make sure to reimplement these functions if you can provide support for any of the options in the ImageOption enum.

To write your own image handler, you must at least reimplement canRead() and read(). Then create a QImageIOPlugin that can create the handler. Finally, install your plugin, and QImageReader and QImageWriter will then automatically load the plugin, and start using it.

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
Animation attribute Any (shared captured text)
BackgroundColor attribute Any (shared captured text)
ClipRect attribute Any (shared captured text)
CompressionRatio attribute Any (shared captured text)
Description attribute Any (shared captured text)
Endianness attribute Any (shared captured text)
Gamma attribute Any (shared captured text)
ImageFormat attribute Any (shared captured text)
ImageOption attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
ImageTransformation attribute Any (shared captured text)
IncrementalReading attribute Any (shared captured text)
Name attribute Any (shared captured text)
OptimizedWrite attribute Any (shared captured text)
ProgressiveScanWrite attribute Any (shared captured text)
Quality attribute Any (shared captured text)
ScaledClipRect attribute Any (shared captured text)
ScaledSize attribute Any (shared captured text)
Size attribute Any (shared captured text)
SubType attribute Any (shared captured text)
SupportedSubTypes attribute Any (shared captured text)
Transformation attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
TransformationFlip attribute Any (shared captured text)
TransformationFlipAndRotate90 attribute Any (shared captured text)
TransformationMirror attribute Any (shared captured text)
TransformationMirrorAndRotate90 attribute Any (shared captured text)
TransformationNone attribute Any (shared captured text)
TransformationRotate180 attribute Any (shared captured text)
TransformationRotate270 attribute Any (shared captured text)
TransformationRotate90 attribute Any (shared captured text)
TransformedByDefault attribute Any (shared captured text)
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
canRead function (self) -> bool X.canRead() -> bool (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
currentImageNumber function (self) -> int X.currentImageNumber() -> int (shared captured text)
currentImageRect function (self) -> Any X.currentImageRect() -> PythonQt.QtCore.QRect (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
device function (self) -> Any X.device() -> PythonQt.QtCore.QIODevice (shared captured text)
format function (self) -> Any X.format() -> PythonQt.QtCore.QByteArray (shared captured text)
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
imageCount function (self) -> int X.imageCount() -> int (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
jumpToImage function (self, imageNumber: int) -> bool X.jumpToImage(imageNumber) -> bool (shared captured text)
jumpToNextImage function (self) -> bool X.jumpToNextImage() -> bool (shared captured text)
loopCount function (self) -> int X.loopCount() -> int (shared captured text)
nextImageDelay function (self) -> int X.nextImageDelay() -> int (shared captured text)
option function (self, option: Any) -> Any X.option(option) -> object (shared captured text)
read function (self, image: Any) -> bool X.read(image) -> bool (shared captured text)
setDevice function (self, device: Any) -> None Sets the device of the [QImageIOHandler](https://doc.qt.io/archives/qt-5.15/qimageiohandler.html) to device. (shared captured text)
setFormat function (self, format: Any) -> None Sets the format of the [QImageIOHandler](https://doc.qt.io/archives/qt-5.15/qimageiohandler.html) to format. (shared captured text)
setOption function (self, option: Any, value: Any) -> None X.setOption(option, value) (shared captured text)
supportsOption function (self, option: Any) -> bool X.supportsOption(option) -> bool (shared captured text)
write function (self, image: Any) -> bool X.write(image) -> bool (shared captured text)