QShortcut Class

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

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

Member Function Documentation

[explicit] QShortcut::QShortcut(QObject *parent)

Constructs a QShortcut object for the parent, which should be a QWindow or a QWidget.

Since no shortcut key sequence is specified, the shortcut will not emit any signals.

See also setKey().

[explicit] QShortcut::QShortcut(const QKeySequence &key, QObject *parent, const char *member = nullptr, const char *ambiguousMember = nullptr, Qt::ShortcutContext context = Qt::WindowShortcut)

Constructs a QShortcut object for the parent, which should be a QWindow or a QWidget.

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.

[explicit, since 6.0] QShortcut::QShortcut(QKeySequence::StandardKey standardKey, QObject *parent, const char *member = nullptr, const char *ambiguousMember = nullptr, Qt::ShortcutContext context = Qt::WindowShortcut)

Constructs a QShortcut object for the parent, which should be a QWindow or a QWidget.

The shortcut operates on its parent, listening for QShortcutEvents that match the standardKey. 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.

This function was introduced in Qt 6.0.

template <typename Functor> QShortcut::QShortcut(const QKeySequence &key, QObject *parent, Functor functor, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)

This is an overloaded function.

This is a QShortcut convenience constructor which connects the shortcut's activated() signal to the functor.

template <typename Functor> QShortcut::QShortcut(const QKeySequence &key, QObject *parent, const QObject *context, Functor functor, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)

This is an overloaded function.

This is a QShortcut convenience constructor which connects the shortcut's activated() signal to the functor.

The functor can be a pointer to a member function of the context object.

If the context object is destroyed, the functor will not be called.

template <typename Functor, typename FunctorAmbiguous> QShortcut::QShortcut(const QKeySequence &key, QObject *parent, const QObject *context, Functor functor, FunctorAmbiguous functorAmbiguous, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)

This is an overloaded function.

This is a QShortcut convenience constructor which connects the shortcut's activated() signal to the functor and activatedAmbiguously() signal to the functorAmbiguous.

The functor and functorAmbiguous can be a pointer to a member function of the context object.

If the context object is destroyed, the functor and functorAmbiguous will not be called.

template <typename Functor, typename FunctorAmbiguous> QShortcut::QShortcut(const QKeySequence &key, QObject *parent, const QObject *context1, Functor functor, const QObject *context2, FunctorAmbiguous functorAmbiguous, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)

This is an overloaded function.

This is a QShortcut convenience constructor which connects the shortcut's activated() signal to the functor and activatedAmbiguously() signal to the functorAmbiguous.

The functor can be a pointer to a member function of the context1 object. The functorAmbiguous can be a pointer to a member function of the context2 object.

If the context1 object is destroyed, the functor will not be called. If the context2 object is destroyed, the functorAmbiguous will not be called.

[since 6.0] template <typename Functor> QShortcut::QShortcut(QKeySequence::StandardKey key, QObject *parent, Functor functor, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)

This is an overloaded function.

This is a QShortcut convenience constructor which connects the shortcut's activated() signal to the functor.

This function was introduced in Qt 6.0.

[since 6.0] template <typename Functor> QShortcut::QShortcut(QKeySequence::StandardKey key, QObject *parent, const QObject *context, Functor functor, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)

This is an overloaded function.

This is a QShortcut convenience constructor which connects the shortcut's activated() signal to the functor.

The functor can be a pointer to a member function of the context object.

If the context object is destroyed, the functor will not be called.

This function was introduced in Qt 6.0.

[since 6.0] template <typename Functor, typename FunctorAmbiguous> QShortcut::QShortcut(QKeySequence::StandardKey key, QObject *parent, const QObject *context, Functor functor, FunctorAmbiguous functorAmbiguous, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)

This is an overloaded function.

This is a QShortcut convenience constructor which connects the shortcut's activated() signal to the functor and activatedAmbiguously() signal to the functorAmbiguous.

The functor and functorAmbiguous can be a pointer to a member function of the context object.

If the context object is destroyed, the functor and functorAmbiguous will not be called.

This function was introduced in Qt 6.0.

[since 6.0] template <typename Functor, typename FunctorAmbiguous> QShortcut::QShortcut(QKeySequence::StandardKey key, QObject *parent, const QObject *context1, Functor functor, const QObject *context2, FunctorAmbiguous functorAmbiguous, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)

This is an overloaded function.

This is a QShortcut convenience constructor which connects the shortcut's activated() signal to the functor and activatedAmbiguously() signal to the functorAmbiguous.

The functor can be a pointer to a member function of the context1 object. The functorAmbiguous can be a pointer to a member function of the context2 object.

If the context1 object is destroyed, the functor will not be called. If the context2 object is destroyed, the functorAmbiguous will not be called.

This function was introduced in Qt 6.0.

[virtual noexcept] QShortcut::~QShortcut()

Destroys the shortcut.

[signal] void QShortcut::activated()

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

See also activatedAmbiguously().

[signal] void QShortcut::activatedAmbiguously()

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

[since 6.0] QList<QKeySequence> QShortcut::keys() const

Returns the list of key sequences which trigger this shortcut.

This function was introduced in Qt 6.0.

See also key and setKeys().

QWidget *QShortcut::parentWidget() const

Returns the shortcut's parent widget.

[since 6.0] void QShortcut::setKeys(QKeySequence::StandardKey key)

Sets the triggers to those matching the standard key key.

This function was introduced in Qt 6.0.

See also key and keys().

[since 6.0] void QShortcut::setKeys(const QList<QKeySequence> &keys)

Sets keys as the list of key sequences that trigger the shortcut.

This function was introduced in Qt 6.0.

See also key and keys().

void QShortcut::setWhatsThis(const QString &text)

Sets the shortcut's "What's This?" help text.

The text will be shown when a widget 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, the help text is an empty string.

This function has no effect in applications that don't use widgets.

See also whatsThis(), QWhatsThis::inWhatsThisMode(), and QAction::setWhatsThis().

QString QShortcut::whatsThis() const

Returns the shortcut's "What's This?" help text.

See also setWhatsThis().