Skip to content

Clipboard

Base classes

Name Children Inherits
ObjectMixin
prettyqt.core.object

⋔ Inheritance diagram

graph TD
  1473245549456["gui.Clipboard"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473299815024 --> 1473245549456
  140713234304496 --> 1473299815024

🛈 DocStrings

Bases: ObjectMixin

Access to the window system clipboard.

Source code in prettyqt\gui\clipboard.py 
18
19
20
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
class Clipboard(core.ObjectMixin):
    """Access to the window system clipboard."""

    def __init__(self, item: gui.QClipboard):
        self.item = item

    def __getattr__(self, val):
        return getattr(self.item, val)

    def set_pixmap(
        self,
        pixmap: gui.QPixmap | None,
        mode: ModeStr | gui.QClipboard.Mode = "clipboard",
    ):
        if pixmap is None:
            pixmap = gui.QPixmap()
        self.item.setPixmap(pixmap, MODES.get_enum_value(mode))

    def get_pixmap(
        self, mode: ModeStr | gui.QClipboard.Mode = "clipboard"
    ) -> gui.Pixmap | None:
        val = MODES.get_enum_value(mode)
        pix = gui.Pixmap(self.item.pixmap(val))
        return None if pix.isNull() else pix

    def set_image(
        self,
        image: gui.QImage | None,
        mode: ModeStr | gui.QClipboard.Mode = "clipboard",
    ):
        if image is None:
            image = gui.QImage()
        self.item.setImage(image, MODES.get_enum_value(mode))

    def get_image(
        self, mode: ModeStr | gui.QClipboard.Mode = "clipboard"
    ) -> gui.Image | None:
        img = gui.Image(self.item.image(MODES.get_enum_value(mode)))
        return None if img.isNull() else img

    def set_mimedata(
        self,
        mimedata: core.QMimeData,
        mode: ModeStr | gui.QClipboard.Mode = "clipboard",
    ):
        self.item.setMimeData(mimedata, MODES.get_enum_value(mode))

    def get_mimedata(
        self, mode: ModeStr | gui.QClipboard.Mode = "clipboard"
    ) -> core.QMimeData:
        return self.item.mimeData(MODES.get_enum_value(mode))

    def set_text(self, text: str, mode: ModeStr | gui.QClipboard.Mode = "clipboard"):
        self.item.setText(text, MODES.get_enum_value(mode))

    def get_text(self, mode: ModeStr | gui.QClipboard.Mode = "clipboard") -> str:
        return self.item.text(MODES.get_enum_value(mode))