#include <qquickshortcut_p.h>

Inheritance diagram for QQuickShortcut:

Collaboration diagram for QQuickShortcut:

Classes
struct	Shortcut

Signals
void	sequenceChanged ()

	Q_REVISION (2, 9) void sequencesChanged()

void	enabledChanged ()

void	autoRepeatChanged ()

void	contextChanged ()

void	activated ()

void	activatedAmbiguously ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickShortcut (QObject *parent=nullptr)

	~QQuickShortcut ()

QVariant	sequence () const
	\qmlproperty keysequence QtQuick::Shortcut::sequence

void	setSequence (const QVariant &sequence)

QVariantList	sequences () const
	\qmlproperty list<keysequence> QtQuick::Shortcut::sequences

void	setSequences (const QVariantList &sequences)

QString	nativeText () const
	\qmlproperty string QtQuick::Shortcut::nativeText

QString	portableText () const
	\qmlproperty string QtQuick::Shortcut::portableText

bool	isEnabled () const
	\qmlproperty bool QtQuick::Shortcut::enabled

void	setEnabled (bool enabled)

bool	autoRepeat () const
	\qmlproperty bool QtQuick::Shortcut::autoRepeat

void	setAutoRepeat (bool repeat)

Qt::ShortcutContext	context () const
	\qmlproperty enumeration QtQuick::Shortcut::context

void	setContext (Qt::ShortcutContext context)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Protected Member Functions
void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

bool	event (QEvent *event) override
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

void	setEnabled (Shortcut &shortcut, bool enabled)

void	setAutoRepeat (Shortcut &shortcut, bool repeat)

void	grabShortcut (Shortcut &shortcut, Qt::ShortcutContext context)

void	ungrabShortcut (Shortcut &shortcut)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties
QVariant	sequence

QVariantList	sequences

QString	nativeText

QString	portableText

bool	enabled

bool	autoRepeat

Qt::ShortcutContext	context

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 31 of file qquickshortcut_p.h.

Constructor & Destructor Documentation

◆ QQuickShortcut()

QQuickShortcut::QQuickShortcut ( QObject * parent = nullptr )

explicit

Definition at line 122 of file qquickshortcut.cpp.

◆ ~QQuickShortcut()

QQuickShortcut::~QQuickShortcut ( )

Definition at line 127 of file qquickshortcut.cpp.

References shortcut, and ungrabShortcut().

Here is the call graph for this function:

Member Function Documentation

◆ activated

void QQuickShortcut::activated ( )

signal

Referenced by event().

Here is the caller graph for this function:

◆ activatedAmbiguously

void QQuickShortcut::activatedAmbiguously ( )

signal

Referenced by event().

Here is the caller graph for this function:

◆ autoRepeat()

bool QQuickShortcut::autoRepeat ( ) const

\qmlproperty bool QtQuick::Shortcut::autoRepeat

This property holds whether the shortcut can auto repeat.

The default value is true.

Definition at line 303 of file qquickshortcut.cpp.

◆ autoRepeatChanged

void QQuickShortcut::autoRepeatChanged ( )

signal

Referenced by setAutoRepeat().

Here is the caller graph for this function:

◆ classBegin()

void QQuickShortcut::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 364 of file qquickshortcut.cpp.

◆ componentComplete()

void QQuickShortcut::componentComplete ( )

overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 368 of file qquickshortcut.cpp.

References grabShortcut(), and shortcut.

Here is the call graph for this function:

◆ context()

Qt::ShortcutContext QQuickShortcut::context ( ) const

\qmlproperty enumeration QtQuick::Shortcut::context

This property holds the \l{Qt::ShortcutContext}{shortcut context}.

Supported values are:

\value Qt.WindowShortcut (default) The shortcut is active when its parent item is in an active top-level window. \value Qt.ApplicationShortcut The shortcut is active when one of the application's windows are active.

\qml Shortcut { sequence: StandardKey.Quit context: Qt.ApplicationShortcut onActivated: Qt.quit() } \endqml

Definition at line 341 of file qquickshortcut.cpp.

◆ contextChanged

void QQuickShortcut::contextChanged ( )

signal

Referenced by setContext().

Here is the caller graph for this function:

◆ enabledChanged

void QQuickShortcut::enabledChanged ( )

signal

Referenced by setEnabled().

Here is the caller graph for this function:

◆ event()

bool QQuickShortcut::event ( QEvent * e )

overrideprotectedvirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
    Q_OBJECT
 
public:
    MyClass(QWidget *parent = nullptr);
    ~MyClass();
 
    bool event(QEvent* ev) override
    {
        if (ev->type() == QEvent::PolishRequest) {
            // overwrite handling of PolishRequest if any
            doThings();
            return true;
        } else  if (ev->type() == QEvent::Show) {
            // complement handling of Show if any
            doThings2();
            QWidget::event(ev);
            return true;
        }
        // Make sure the rest of events are handled
        return QWidget::event(ev);
    }
};

See also: installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 376 of file qquickshortcut.cpp.

References activated(), activatedAmbiguously(), emit, i, match(), QQuickShortcut::Shortcut::matches(), and QEvent::Shortcut.

Here is the call graph for this function:

◆ grabShortcut()

void QQuickShortcut::grabShortcut	(	Shortcut &	shortcut,
		Qt::ShortcutContext	context )

protected

Definition at line 412 of file qquickshortcut.cpp.

References context, QGuiApplicationPrivate::instance(), and shortcut.

Referenced by componentComplete(), setContext(), setSequence(), and setSequences().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEnabled()

bool QQuickShortcut::isEnabled ( ) const

\qmlproperty bool QtQuick::Shortcut::enabled

This property holds whether the shortcut is enabled.

The default value is true.

Definition at line 278 of file qquickshortcut.cpp.

◆ nativeText()

QString QQuickShortcut::nativeText ( ) const

\qmlproperty string QtQuick::Shortcut::nativeText

Since: 5.6

This property provides the shortcut's key sequence as a platform specific string. This means that it will be shown translated, and on \macos it will resemble a key sequence from the menu bar. It is best to display this text to the user (for example, on a tooltip).

See also: sequence, portableText

Definition at line 251 of file qquickshortcut.cpp.

References QQuickShortcut::Shortcut::keySequence, QKeySequence::NativeText, and QKeySequence::toString().

Here is the call graph for this function:

◆ portableText()

QString QQuickShortcut::portableText ( ) const

\qmlproperty string QtQuick::Shortcut::portableText

Since: 5.6

This property provides the shortcut's key sequence as a string in a "portable" format, suitable for reading and writing to a file. In many cases, it will look similar to the native text on Windows and X11.

See also: sequence, nativeText

Definition at line 266 of file qquickshortcut.cpp.

References QQuickShortcut::Shortcut::keySequence, QKeySequence::PortableText, and QKeySequence::toString().

Here is the call graph for this function:

◆ Q_REVISION

QQuickShortcut::Q_REVISION	(	2	,
		9	)

signal

◆ sequence()

QVariant QQuickShortcut::sequence ( ) const

\qmlproperty keysequence QtQuick::Shortcut::sequence

This property holds the shortcut's key sequence. The key sequence can be set to one of the \l{QKeySequence::StandardKey}{standard keyboard shortcuts}, or it can be described with a string containing a sequence of up to four key presses that are needed to \l{Shortcut::activated}{activate} the shortcut.

The default value is an empty key sequence.

\qml Shortcut { sequence: "Ctrl+E,Ctrl+W" onActivated: edit.wrapMode = TextEdit.Wrap } \endqml

Note: Given that standard keys can resolve to one shortcut on some platforms, but multiple shortcuts on other platforms, we recommend always using \l{Shortcut::}{sequences} for standard keys.

See also: sequences

Definition at line 157 of file qquickshortcut.cpp.

References QQuickShortcut::Shortcut::userValue.

◆ sequenceChanged

void QQuickShortcut::sequenceChanged ( )

signal

Referenced by setSequence().

Here is the caller graph for this function:

◆ sequences()

QVariantList QQuickShortcut::sequences ( ) const

\qmlproperty list<keysequence> QtQuick::Shortcut::sequences

Since: 5.9

This property holds multiple key sequences for the shortcut. The key sequences can be set to one of the \l{QKeySequence::StandardKey}{standard keyboard shortcuts}, or they can be described with strings containing sequences of up to four key presses that are needed to \l{Shortcut::activated}{activate} the shortcut.

\qml Shortcut { sequences: [StandardKey.Cut, "Ctrl+X", "Shift+Del"] onActivated: edit.cut() } \endqml

Definition at line 192 of file qquickshortcut.cpp.

References shortcut.

◆ setAutoRepeat() [1/2]

void QQuickShortcut::setAutoRepeat ( bool repeat )

Definition at line 308 of file qquickshortcut.cpp.

References autoRepeatChanged(), emit, setAutoRepeat(), and shortcut.

Referenced by setAutoRepeat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoRepeat() [2/2]

void QQuickShortcut::setAutoRepeat	(	QQuickShortcut::Shortcut &	shortcut,
		bool	repeat )

protected

Definition at line 406 of file qquickshortcut.cpp.

References QGuiApplicationPrivate::instance(), and shortcut.

Here is the call graph for this function:

◆ setContext()

void QQuickShortcut::setContext ( Qt::ShortcutContext context )

Definition at line 346 of file qquickshortcut.cpp.

References context, contextChanged(), emit, grabShortcut(), and ungrabShortcut().

Here is the call graph for this function:

◆ setEnabled() [1/2]

void QQuickShortcut::setEnabled ( bool enabled )

Definition at line 283 of file qquickshortcut.cpp.

References emit, enabled, enabledChanged(), setEnabled(), and shortcut.

Referenced by setEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEnabled() [2/2]

void QQuickShortcut::setEnabled	(	QQuickShortcut::Shortcut &	shortcut,
		bool	enabled )

protected

Definition at line 400 of file qquickshortcut.cpp.

References QGuiApplicationPrivate::instance(), and shortcut.

Here is the call graph for this function:

◆ setSequence()

void QQuickShortcut::setSequence ( const QVariant & sequence )

Definition at line 162 of file qquickshortcut.cpp.

References emit, grabShortcut(), QQuickShortcut::Shortcut::keySequence, sequenceChanged(), ungrabShortcut(), QQuickShortcut::Shortcut::userValue, and valueToKeySequence().

Here is the call graph for this function:

◆ setSequences()

void QQuickShortcut::setSequences ( const QVariantList & sequences )

Definition at line 200 of file qquickshortcut.cpp.

References emit, grabShortcut(), i, QQuickShortcut::Shortcut::keySequence, list, shortcut, ungrabShortcut(), QQuickShortcut::Shortcut::userValue, and valueToKeySequences().

Here is the call graph for this function:

◆ ungrabShortcut()

void QQuickShortcut::ungrabShortcut ( Shortcut & shortcut )

protected

Definition at line 424 of file qquickshortcut.cpp.

References QGuiApplicationPrivate::instance(), and shortcut.

Referenced by ~QQuickShortcut(), setContext(), setSequence(), and setSequences().

Here is the call graph for this function:

Here is the caller graph for this function:

Property Documentation

◆ autoRepeat

bool QQuickShortcut::autoRepeat

readwrite

Definition at line 40 of file qquickshortcut_p.h.

◆ context

Qt::ShortcutContext QQuickShortcut::context

readwrite

Definition at line 41 of file qquickshortcut_p.h.

Referenced by grabShortcut(), and setContext().

◆ enabled

bool QQuickShortcut::enabled

readwrite

Definition at line 39 of file qquickshortcut_p.h.

Referenced by setEnabled().

◆ nativeText

QString QQuickShortcut::nativeText

read

Definition at line 37 of file qquickshortcut_p.h.

◆ portableText

QString QQuickShortcut::portableText

read

Definition at line 38 of file qquickshortcut_p.h.

◆ sequence

QVariant QQuickShortcut::sequence

readwrite

Definition at line 35 of file qquickshortcut_p.h.

◆ sequences

QVariantList QQuickShortcut::sequences

readwrite

Definition at line 36 of file qquickshortcut_p.h.

The documentation for this class was generated from the following files:

qtdeclarative/src/quick/util/qquickshortcut_p.h (9dd45fff835a7c261dacc9ee6239d42ef1a74bbe)
qtdeclarative/src/quick/util/qquickshortcut.cpp (9dd45fff835a7c261dacc9ee6239d42ef1a74bbe)

Classes

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickShortcut()

◆ ~QQuickShortcut()

Member Function Documentation

◆ activated

◆ activatedAmbiguously

◆ autoRepeat()

◆ autoRepeatChanged

◆ classBegin()

◆ componentComplete()

◆ context()

◆ contextChanged

◆ enabledChanged

◆ event()

◆ grabShortcut()

◆ isEnabled()

◆ nativeText()

◆ portableText()

◆ Q_REVISION

◆ sequence()

◆ sequenceChanged

◆ sequences()

◆ setAutoRepeat() [1/2]

◆ setAutoRepeat() [2/2]

◆ setContext()

◆ setEnabled() [1/2]

◆ setEnabled() [2/2]

◆ setSequence()

◆ setSequences()

◆ ungrabShortcut()

Property Documentation

◆ autoRepeat

◆ context

◆ enabled

◆ nativeText

◆ portableText

◆ sequence

◆ sequences