Skip to content

Shortcut

Qt Base Class: QShortcut

Signature: QShortcut(self, arg__1: PySide6.QtGui.QKeySequence.StandardKey, arg__2: PySide6.QtCore.QObject, arg__3: Callable, arg__4: PySide6.QtCore.Qt.ShortcutContext = Instance(Qt.WindowShortcut)) -> None QShortcut(self, arg__1: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], arg__2: PySide6.QtCore.QObject, arg__3: Callable, arg__4: PySide6.QtCore.Qt.ShortcutContext = Instance(Qt.WindowShortcut)) -> None QShortcut(self, key: PySide6.QtGui.QKeySequence.StandardKey, parent: PySide6.QtCore.QObject, member: Optional[bytes] = None, ambiguousMember: Optional[bytes] = None, context: PySide6.QtCore.Qt.ShortcutContext = Instance(Qt.WindowShortcut)) -> None QShortcut(self, key: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], parent: PySide6.QtCore.QObject, member: Optional[bytes] = None, ambiguousMember: Optional[bytes] = None, context: PySide6.QtCore.Qt.ShortcutContext = Instance(Qt.WindowShortcut)) -> None QShortcut(self, parent: PySide6.QtCore.QObject) -> None

Base classes

Name Children Inherits
ObjectMixin
prettyqt.core.object
QShortcut
PySide6.QtGui
QShortcut(self, arg__1: PySide6.QtGui.QKeySequence.StandardKey, arg__2: PySide6.QtCore.QObject, arg__3: Callable, arg__4: PySide6.QtCore.Qt.ShortcutContext \= Instance(Qt.WindowShortcut)) -> None

⋔ Inheritance diagram

graph TD
  1473245523104["gui.Shortcut"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473289232016["QtGui.QShortcut"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473299815024 --> 1473245523104
  140713234304496 --> 1473299815024
  1473289232016 --> 1473245523104
  1473288842240 --> 1473289232016
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: ObjectMixin, QShortcut

Source code in prettyqt\gui\shortcut.py 
 9
10
11
12
13
14
15
16
17
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
class Shortcut(core.ObjectMixin, gui.QShortcut):
    def __init__(self, *args, **kwargs):
        match args:
            case (str(), *rest):
                args = (gui.KeySequence(args[0]), *rest)
        super().__init__(*args, **kwargs)

    def __str__(self):
        return self.key().toString()

    def set_context(
        self, context: constants.ShortcutContextStr | constants.ShortcutContext
    ):
        """Set shortcut context.

        Args:
            context: shortcut context
        """
        self.setContext(constants.SHORTCUT_CONTEXT.get_enum_value(context))

    def get_context(self) -> constants.ShortcutContextStr:
        """Return shortcut context.

        Returns:
            shortcut context
        """
        return constants.SHORTCUT_CONTEXT.inverse[self.context()]

    def set_key(
        self,
        key: datatypes.KeyCombinationType,
    ):
        keysequence = gui.KeySequence(key)
        self.setKey(keysequence)

    def set_keys(self, keys: Iterable[datatypes.KeyCombinationType]):
        keysequences = [gui.KeySequence(key) for key in keys]
        self.setKeys(keysequences)

    def get_key(self) -> gui.KeySequence:
        """Return the shortcut's key sequence.

        Returns:
            Key sequence
        """
        return gui.KeySequence(self.key())

    def get_keys(self) -> list[gui.KeySequence]:
        return [gui.KeySequence(i) for i in self]

get_context() -> constants.ShortcutContextStr

Return shortcut context.

Source code in prettyqt\gui\shortcut.py 
29
30
31
32
33
34
35
def get_context(self) -> constants.ShortcutContextStr:
    """Return shortcut context.

    Returns:
        shortcut context
    """
    return constants.SHORTCUT_CONTEXT.inverse[self.context()]

get_key() -> gui.KeySequence

Return the shortcut's key sequence.

Source code in prettyqt\gui\shortcut.py 
48
49
50
51
52
53
54
def get_key(self) -> gui.KeySequence:
    """Return the shortcut's key sequence.

    Returns:
        Key sequence
    """
    return gui.KeySequence(self.key())

set_context(context: constants.ShortcutContextStr | constants.ShortcutContext)

Set shortcut context.

Parameters:

Name Type Description Default
context ShortcutContextStr | ShortcutContext

shortcut context

 required
Source code in prettyqt\gui\shortcut.py 
19
20
21
22
23
24
25
26
27
def set_context(
    self, context: constants.ShortcutContextStr | constants.ShortcutContext
):
    """Set shortcut context.

    Args:
        context: shortcut context
    """
    self.setContext(constants.SHORTCUT_CONTEXT.get_enum_value(context))

⌗ Property table

Qt Property Type Doc
objectName QString
key QKeySequence
enabled bool
autoRepeat bool
context Qt::ShortcutContext