Skip to content

IconEngine

Qt Base Class: QIconEngine

Signature: QIconEngine(self) -> None QIconEngine(self, other: PySide6.QtGui.QIconEngine) -> None

Base classes

Name Children Inherits
SerializeMixin
prettyqt.utils.serializemixin
QIconEngine
PySide6.QtGui
QIconEngine(self) -> None

Subclasses

Class Module Description
CharIconEngine prettyqt.iconprovider.chariconengine

⋔ Inheritance diagram

graph TD
  1473245547504["gui.IconEngine"]
  1473299806240["utils.SerializeMixin"]
  140713234304496["builtins.object"]
  1473300116528["QtGui.QIconEngine"]
  1473291690208["Shiboken.Object"]
  1473299806240 --> 1473245547504
  140713234304496 --> 1473299806240
  1473300116528 --> 1473245547504
  1473291690208 --> 1473300116528
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: SerializeMixin, QIconEngine

Abstract base class for QIcon renderers.

Source code in prettyqt\gui\iconengine.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
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
class IconEngine(serializemixin.SerializeMixin, gui.QIconEngine):
    """Abstract base class for QIcon renderers."""

    def __repr__(self):
        return get_repr(self)

    def __bool__(self):
        return not self.isNull()

    def add_file(
        self,
        path: datatypes.PathType,
        size: datatypes.SizeType,
        mode: gui.icon.ModeStr | gui.QIcon.Mode,
        state: gui.icon.StateStr | gui.QIcon.State,
    ):
        self.addFile(
            os.fspath(path),
            datatypes.to_size(size),
            gui.icon.MODE.get_enum_value(mode),
            gui.icon.STATE.get_enum_value(state),
        )

    def add_pixmap(
        self,
        pixmap: gui.QPixmap,
        mode: gui.icon.ModeStr | gui.QIcon.Mode,
        state: gui.icon.StateStr | gui.QIcon.State,
    ):
        self.addPixmap(
            pixmap,
            gui.icon.MODE.get_enum_value(mode),
            gui.icon.STATE.get_enum_value(state),
        )

    def get_actual_size(
        self,
        size: datatypes.SizeType,
        mode: gui.icon.ModeStr | gui.QIcon.Mode = "normal",
        state: gui.icon.StateStr | gui.QIcon.State = "off",
    ) -> core.Size:
        return core.Size(
            self.actualSize(
                datatypes.to_size(size),
                gui.icon.MODE.get_enum_value(mode),
                gui.icon.STATE.get_enum_value(state),
            )
        )

    def get_available_sizes(
        self,
        mode: gui.icon.ModeStr | gui.QIcon.Mode = "normal",
        state: gui.icon.StateStr | gui.QIcon.State = "off",
    ) -> list[core.Size]:
        return [
            core.Size(i)
            for i in self.availableSizes(
                gui.icon.MODE.get_enum_value(mode), gui.icon.STATE.get_enum_value(state)
            )
        ]

    def get_pixmap(
        self,
        size: datatypes.SizeType,
        mode: gui.icon.ModeStr | gui.QIcon.Mode = "normal",
        state: gui.icon.StateStr | gui.QIcon.State = "off",
        scale: float | None = None,
    ) -> gui.Pixmap:
        if scale is None:
            return gui.Pixmap(
                self.pixmap(
                    datatypes.to_size(size),
                    gui.icon.MODE.get_enum_value(mode),
                    gui.icon.STATE.get_enum_value(state),
                )
            )
        else:
            return gui.Pixmap(
                self.scaledPixmap(
                    datatypes.to_size(size),
                    gui.icon.MODE.get_enum_value(mode),
                    gui.icon.STATE.get_enum_value(state),
                    scale,
                )
            )