Skip to content

ImageWriter

Qt Base Class: QImageWriter

Signature: QImageWriter(self) -> None QImageWriter(self, device: PySide6.QtCore.QIODevice, format: Union[PySide6.QtCore.QByteArray, bytes]) -> None QImageWriter(self, fileName: str, format: Union[PySide6.QtCore.QByteArray, bytes] = Default(QByteArray)) -> None

Base classes

Name Children Inherits
QImageWriter
PySide6.QtGui
QImageWriter(self) -> None

⋔ Inheritance diagram

graph TD
  1473245612896["gui.ImageWriter"]
  1473245499680["QtGui.QImageWriter"]
  1473291690208["Shiboken.Object"]
  140713234304496["builtins.object"]
  1473245499680 --> 1473245612896
  1473291690208 --> 1473245499680
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: QImageWriter

Format independent interface for writing images to files or other devices.

Source code in prettyqt\gui\imagewriter.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class ImageWriter(gui.QImageWriter):
    """Format independent interface for writing images to files or other devices."""

    def __setitem__(self, key: str, val: str):
        self.setText(key, val)

    def get_error(self) -> ImageWriterErrorStr:
        """Return error type.

        Returns:
            error type
        """
        return IMAGE_WRITER_ERROR.inverse[self.error()]

    def get_format(self) -> str:
        return self.format().data().decode()

    def get_subtype(self) -> str:
        return self.subType().data().decode()

    def get_supported_image_formats(self) -> list[str]:
        return [i.data().decode() for i in self.supportedImageFormats()]

    def get_supported_subtypes(self) -> list[str]:
        return [i.data().decode() for i in self.supportedSubTypes()]

    def set_subtype(self, subtype: datatypes.ByteArrayType):
        subtype = datatypes.to_bytearray(subtype)
        self.setSubType(subtype)

    def set_format(self, fmt: datatypes.ByteArrayType):
        fmt = datatypes.to_bytearray(fmt)
        self.setFormat(fmt)

    def set_transformation(
        self,
        origin: gui.imageiohandler.TransformationStr | gui.ImageIOHandler.Transformation,
    ):
        """Set the image transformations metadata including orientation.

        Args:
            origin: transformation to use
        """
        self.setTransformation(gui.imageiohandler.TRANSFORMATION.get_enum_value(origin))

    def get_transformation(self) -> gui.imageiohandler.TransformationStr:
        """Return the transformation and orientation the image has been set to.

        Returns:
            transformation
        """
        return gui.imageiohandler.TRANSFORMATION.inverse[self.transformation()]

get_error() -> ImageWriterErrorStr

Return error type.

Source code in prettyqt\gui\imagewriter.py 
27
28
29
30
31
32
33
def get_error(self) -> ImageWriterErrorStr:
    """Return error type.

    Returns:
        error type
    """
    return IMAGE_WRITER_ERROR.inverse[self.error()]

get_transformation() -> gui.imageiohandler.TransformationStr

Return the transformation and orientation the image has been set to.

Source code in prettyqt\gui\imagewriter.py 
66
67
68
69
70
71
72
def get_transformation(self) -> gui.imageiohandler.TransformationStr:
    """Return the transformation and orientation the image has been set to.

    Returns:
        transformation
    """
    return gui.imageiohandler.TRANSFORMATION.inverse[self.transformation()]

set_transformation(origin: gui.imageiohandler.TransformationStr | gui.ImageIOHandler.Transformation)

Set the image transformations metadata including orientation.

Parameters:

Name Type Description Default
origin TransformationStr | Transformation

transformation to use

 required
Source code in prettyqt\gui\imagewriter.py 
55
56
57
58
59
60
61
62
63
64
def set_transformation(
    self,
    origin: gui.imageiohandler.TransformationStr | gui.ImageIOHandler.Transformation,
):
    """Set the image transformations metadata including orientation.

    Args:
        origin: transformation to use
    """
    self.setTransformation(gui.imageiohandler.TRANSFORMATION.get_enum_value(origin))