Home · All Classes · Modules

QShortcut Class Reference
[QtGui module]

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

Inherits QObject.


Qt Signals

Detailed Description

The QShortcut class is used to create keyboard shortcuts.

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 = new QShortcut(QKeySequence(tr("Ctrl+O", "File|Open")),

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().

Method Documentation

QShortcut.__init__ (self, QWidget parent)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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().

QShortcut.__init__ (self, QKeySequence key, QWidget parent, object member = 0, object ambiguousMember = 0, Qt.ShortcutContext context = Qt.WindowShortcut)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a QShortcut object for the parent widget. The shortcut operates on its parent, listening for QShortcutEvents that match the key sequence. Depending on the ambiguity of the event, the shortcut will call the member function, or the ambiguousMember function, if the key press was in the shortcut's context.

bool QShortcut.autoRepeat (self)

Qt.ShortcutContext QShortcut.context (self)

bool QShortcut.event (self, QEvent e)

int QShortcut.id (self)

Returns the shortcut's ID.

See also QShortcutEvent.shortcutId().

bool QShortcut.isEnabled (self)

QKeySequence QShortcut.key (self)

QWidget QShortcut.parentWidget (self)

Returns the shortcut's parent widget.

QShortcut.setAutoRepeat (self, bool on)

QShortcut.setContext (self, Qt.ShortcutContext context)

QShortcut.setEnabled (self, bool enable)

QShortcut.setKey (self, QKeySequence key)

QShortcut.setWhatsThis (self, QString text)

QString QShortcut.whatsThis (self)

Qt Signal Documentation

void activated ()

This is the default overload of this signal.

This signal is emitted when the user types the shortcut's key sequence.

See also activatedAmbiguously().

void activatedAmbiguously ()

This is the default overload of this signal.

When a key sequence is being typed at the keyboard, it is said to be ambiguous as long as it matches the start of more than one shortcut.

When a shortcut's key sequence is completed, activatedAmbiguously() is emitted if the key sequence is still ambiguous (i.e., it is the start of one or more other shortcuts). The activated() signal is not emitted in this case.

See also activated().

PyQt 4.12.1 for X11Copyright © Riverbank Computing Ltd and The Qt Company 2015Qt 4.8.7