QShortcut

The QShortcut class is used to create keyboard shortcuts. More…

Inheritance diagram of PySide2.QtWidgets.QShortcut

Synopsis

Functions

Signals

Detailed Description

The QShortcut class provides a way of connecting keyboard shortcuts to Qt’s signals and slots mechanism, so that objects can be informed when a shortcut is executed. The shortcut can be set up to contain all the key presses necessary to describe a keyboard shortcut, including the states of modifier keys such as Shift, Ctrl, and Alt.

On certain widgets, using ‘&’ in front of a character will automatically create a mnemonic (a shortcut) for that character, e.g. “E&xit” will create the shortcut Alt+X (use ‘&&’ to display an actual ampersand). The widget might consume and perform an action on a given shortcut. On X11 the ampersand will not be shown and the character will be underlined. On Windows, shortcuts are normally not displayed until the user presses the Alt key, but this is a setting the user can change. On Mac, shortcuts are disabled by default. Call qt_set_sequence_auto_mnemonic() to enable them. However, because mnemonic shortcuts do not fit in with Aqua’s guidelines, Qt will not show the shortcut character underlined.

For applications that use menus, it may be more convenient to use the convenience functions provided in the QMenu class to assign keyboard shortcuts to menu items as they are created. Alternatively, shortcuts may be associated with other types of actions in the QAction class.

The simplest way to create a shortcut for a particular widget is to construct the shortcut with a key sequence. For example:

shortcut = QShortcut(QKeySequence(self.tr("Ctrl+O", "File|Open")),
                     parent)

When the user types the key sequence for a given shortcut, the shortcut’s activated() signal is emitted. (In the case of ambiguity, the activatedAmbiguously() signal is emitted.) A shortcut is “listened for” by Qt’s event loop when the shortcut’s parent widget is receiving events.

A shortcut’s key sequence can be set with setKey() and retrieved with key() . A shortcut can be enabled or disabled with setEnabled() , and can have “What’s This?” help text set with setWhatsThis() .

See also

QShortcutEvent QKeySequence QAction

class PySide2.QtWidgets.QShortcut(arg__1, arg__2, arg__3[, arg__4=Qt.WindowShortcut])

PySide2.QtWidgets.QShortcut(parent)

PySide2.QtWidgets.QShortcut(key, parent[, member=None[, ambiguousMember=None[, shortcutContext=Qt.WindowShortcut]]])

param parent:

PySide2.QtWidgets.QWidget

param arg__1:

PySide2.QtGui.QKeySequence

param arg__2:

PySide2.QtWidgets.QWidget

param ambiguousMember:

str

param arg__3:

PyCallable

param arg__4:

ShortcutContext

param member:

str

param shortcutContext:

ShortcutContext

param key:

PySide2.QtGui.QKeySequence

Constructs a QShortcut object for the parent widget. Since no shortcut key sequence is specified, the shortcut will not emit any signals.

See also

setKey()

PySide2.QtWidgets.QShortcut.activated()
PySide2.QtWidgets.QShortcut.activatedAmbiguously()
PySide2.QtWidgets.QShortcut.autoRepeat()
Return type:

bool

This property holds whether the shortcut can auto repeat.

If true, the shortcut will auto repeat when the keyboard shortcut combination is held down, provided that keyboard auto repeat is enabled on the system. The default value is true.

PySide2.QtWidgets.QShortcut.context()
Return type:

ShortcutContext

This property holds the context in which the shortcut is valid.

A shortcut’s context decides in which circumstances a shortcut is allowed to be triggered. The normal context is WindowShortcut , which allows the shortcut to trigger if the parent (the widget containing the shortcut) is a subwidget of the active top-level window.

By default, this property is set to WindowShortcut .

PySide2.QtWidgets.QShortcut.id()
Return type:

int

Returns the shortcut’s ID.

See also

shortcutId()

PySide2.QtWidgets.QShortcut.isEnabled()
Return type:

bool

This property holds whether the shortcut is enabled.

An enabled shortcut emits the activated() or activatedAmbiguously() signal when a QShortcutEvent occurs that matches the shortcut’s key() sequence.

If the application is in WhatsThis mode the shortcut will not emit the signals, but will show the “What’s This?” text instead.

By default, this property is true .

See also

whatsThis

PySide2.QtWidgets.QShortcut.key()
Return type:

PySide2.QtGui.QKeySequence

This property holds the shortcut’s key sequence.

This is a key sequence with an optional combination of Shift, Ctrl, and Alt. The key sequence may be supplied in a number of ways:

setKey(0)                  # no signal emitted
setKey(QKeySequence())     # no signal emitted
setKey(0x3b1)              # Greek letter alpha
setKey(Qt.Key_D)           # 'd', e.g. to delete
setKey('q')                # 'q', e.g. to quit
setKey(Qt.CTRL + Qt.Key_P) # Ctrl+P, e.g. to print document
setKey("Ctrl+P")           # Ctrl+P, e.g. to print document

By default, this property contains an empty key sequence.

PySide2.QtWidgets.QShortcut.parentWidget()
Return type:

PySide2.QtWidgets.QWidget

Returns the shortcut’s parent widget.

PySide2.QtWidgets.QShortcut.setAutoRepeat(on)
Parameters:

on – bool

This property holds whether the shortcut can auto repeat.

If true, the shortcut will auto repeat when the keyboard shortcut combination is held down, provided that keyboard auto repeat is enabled on the system. The default value is true.

PySide2.QtWidgets.QShortcut.setContext(context)
Parameters:

context – ShortcutContext

This property holds the context in which the shortcut is valid.

A shortcut’s context decides in which circumstances a shortcut is allowed to be triggered. The normal context is WindowShortcut , which allows the shortcut to trigger if the parent (the widget containing the shortcut) is a subwidget of the active top-level window.

By default, this property is set to WindowShortcut .

PySide2.QtWidgets.QShortcut.setEnabled(enable)
Parameters:

enable – bool

This property holds whether the shortcut is enabled.

An enabled shortcut emits the activated() or activatedAmbiguously() signal when a QShortcutEvent occurs that matches the shortcut’s key() sequence.

If the application is in WhatsThis mode the shortcut will not emit the signals, but will show the “What’s This?” text instead.

By default, this property is true .

See also

whatsThis

PySide2.QtWidgets.QShortcut.setKey(key)
Parameters:

key – PySide2.QtGui.QKeySequence

This property holds the shortcut’s key sequence.

This is a key sequence with an optional combination of Shift, Ctrl, and Alt. The key sequence may be supplied in a number of ways:

setKey(0)                  # no signal emitted
setKey(QKeySequence())     # no signal emitted
setKey(0x3b1)              # Greek letter alpha
setKey(Qt.Key_D)           # 'd', e.g. to delete
setKey('q')                # 'q', e.g. to quit
setKey(Qt.CTRL + Qt.Key_P) # Ctrl+P, e.g. to print document
setKey("Ctrl+P")           # Ctrl+P, e.g. to print document

By default, this property contains an empty key sequence.

PySide2.QtWidgets.QShortcut.setWhatsThis(text)
Parameters:

text – str

This property holds the shortcut’s “What’s This?” help text.

The text will be shown when the application is in “What’s This?” mode and the user types the shortcut key() sequence.

To set “What’s This?” help on a menu item (with or without a shortcut key), set the help on the item’s action.

By default, this property contains an empty string.

See also

inWhatsThisMode() setWhatsThis()

PySide2.QtWidgets.QShortcut.whatsThis()
Return type:

str

This property holds the shortcut’s “What’s This?” help text.

The text will be shown when the application is in “What’s This?” mode and the user types the shortcut key() sequence.

To set “What’s This?” help on a menu item (with or without a shortcut key), set the help on the item’s action.

By default, this property contains an empty string.

See also

inWhatsThisMode() setWhatsThis()