\qmlproperty int QtQuick::KeyEvent::key More...

#include <qquickevents_p_p.h>

Inheritance diagram for QQuickMouseEvent:

Collaboration diagram for QQuickMouseEvent:

Public Member Functions
	QQuickMouseEvent ()
void	reset (qreal x, qreal y, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, bool isClick=false, bool wasHeld=false, Qt::MouseEventFlags flags={ })
qreal	x () const
qreal	y () const
int	button () const
int	buttons () const
int	modifiers () const
bool	wasHeld () const
bool	isClick () const
void	setX (qreal x)
void	setY (qreal y)
void	setPosition (const QPointF &point)
bool	isAccepted ()
void	setAccepted (bool accepted)
int	flags () const
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	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
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	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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`.

Properties
qreal	x
qreal	y
int	button
int	buttons
int	modifiers
bool	isClick
bool	wasHeld
bool	accepted
int	flags
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
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.
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 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)
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

\qmlproperty int QtQuick::KeyEvent::key

\qmltype KeyEvent
\nativetype QQuickKeyEvent
\inqmlmodule QtQuick
\ingroup qtquick-input-events

\brief Provides information about a key event.

For example, the following changes the Item's state property when the Enter
key is pressed:
\qml

Item { focus: true Keys.onPressed: (event)=> { if (event.key == Qt.Key_Enter) state = 'ShowDetails'; } } \endqml

This property holds the code of the key that was pressed or released.

See \l {Qt::Key}{Qt.Key} for the list of keyboard codes. These codes are independent of the underlying window system. Note that this function does not distinguish between capital and non-capital letters; use the \l {KeyEvent::}{text} property for this purpose.

A value of either 0 or \l {Qt::Key_unknown}{Qt.Key_Unknown} means that the event is not the result of a known key; for example, it may be the result of a compose sequence, a keyboard macro, or due to key event compression.

\qmlproperty string QtQuick::KeyEvent::text

This property holds the Unicode text that the key generated. The text returned can be an empty string in cases where modifier keys, such as Shift, Control, Alt, and Meta, are being pressed or released. In such cases key will contain a valid value

\qmlproperty bool QtQuick::KeyEvent::isAutoRepeat

This property holds whether this event comes from an auto-repeating key.

\qmlproperty quint32 QtQuick::KeyEvent::nativeScanCode

This property contains the native scan code of the key that was pressed. It is passed through from QKeyEvent unchanged.

See also: QKeyEvent::nativeScanCode()

\qmlproperty int QtQuick::KeyEvent::count

This property holds the number of keys involved in this event. If \l KeyEvent::text is not empty, this is simply the length of the string.

\qmlproperty bool QtQuick::KeyEvent::accepted

Setting accepted to true prevents the key event from being propagated to the item's parent.

Generally, if the item acts on the key event then it should be accepted so that ancestor items do not also respond to the same event.

\qmlproperty int QtQuick::KeyEvent::modifiers

This property holds the keyboard modifier flags that existed immediately before the event occurred.

It contains a bitwise combination of numeric values (the same as in Qt::KeyboardModifier):

\value Qt.NoModifier No modifier key is pressed. \value Qt.ShiftModifier A Shift key on the keyboard is pressed. \value Qt.ControlModifier A Ctrl key on the keyboard is pressed. \value Qt.AltModifier An Alt key on the keyboard is pressed. \value Qt.MetaModifier A Meta key on the keyboard is pressed. \value Qt.KeypadModifier A keypad button is pressed. \value Qt.GroupSwitchModifier X11 only. A Mode_switch key on the keyboard is pressed.

For example, to react to a Shift key + Enter key combination: \qml Item { focus: true Keys.onPressed: (event)=> { if ((event.key == Qt.Key_Enter) && (event.modifiers & Qt.ShiftModifier)) doSomething(); } } \endqml

\qmlmethod bool QtQuick::KeyEvent::matches(StandardKey matchKey)

Since: 5.2

Returns true if the key event matches the given standard matchKey; otherwise returns false.

\qml Item { focus: true Keys.onPressed: (event)=> { if (event.matches(StandardKey.Undo)) myModel.undo(); else if (event.matches(StandardKey.Redo)) myModel.redo(); } } \endqml

See also: QKeySequence::StandardKey

\qmltype MouseEvent \nativetype QQuickMouseEvent \inqmlmodule QtQuick

Provides information about a mouse event.

The position of the mouse can be found via the \l {Item::x} {x} and \l {Item::y} {y} properties. The button that caused the event is available via the \l button property.

See also: MouseArea

Definition at line 107 of file qquickevents_p_p.h.

Constructor & Destructor Documentation

◆ QQuickMouseEvent()

QQuickMouseEvent::QQuickMouseEvent ( )

inline

Definition at line 127 of file qquickevents_p_p.h.

Member Function Documentation

◆ button()

int QQuickMouseEvent::button ( ) const

inline

Definition at line 149 of file qquickevents_p_p.h.

◆ buttons()

int QQuickMouseEvent::buttons ( ) const

inline

Definition at line 150 of file qquickevents_p_p.h.

◆ flags()

int QQuickMouseEvent::flags ( ) const

inline

Definition at line 168 of file qquickevents_p_p.h.

◆ isAccepted()

bool QQuickMouseEvent::isAccepted ( )

inline

Definition at line 166 of file qquickevents_p_p.h.

◆ isClick()

bool QQuickMouseEvent::isClick ( ) const

inline

Definition at line 156 of file qquickevents_p_p.h.

◆ modifiers()

int QQuickMouseEvent::modifiers ( ) const

inline

Definition at line 151 of file qquickevents_p_p.h.

◆ reset()

void QQuickMouseEvent::reset	(	qreal	x,
		qreal	y,
		Qt::MouseButton	button,
		Qt::MouseButtons	buttons,
		Qt::KeyboardModifiers	modifiers,
		bool	isClick = false,
		bool	wasHeld = false,
		Qt::MouseEventFlags	flags = { } )

inline

Definition at line 131 of file qquickevents_p_p.h.

◆ setAccepted()

void QQuickMouseEvent::setAccepted ( bool accepted )

inline

Definition at line 167 of file qquickevents_p_p.h.

◆ setPosition()

void QQuickMouseEvent::setPosition ( const QPointF & point )

inline

Definition at line 161 of file qquickevents_p_p.h.

◆ setX()

void QQuickMouseEvent::setX ( qreal x )

inline

Definition at line 159 of file qquickevents_p_p.h.

◆ setY()

void QQuickMouseEvent::setY ( qreal y )

inline

Definition at line 160 of file qquickevents_p_p.h.

◆ wasHeld()

bool QQuickMouseEvent::wasHeld ( ) const

inline

Definition at line 155 of file qquickevents_p_p.h.

◆ x()

qreal QQuickMouseEvent::x ( ) const

inline

Definition at line 147 of file qquickevents_p_p.h.

◆ y()

qreal QQuickMouseEvent::y ( ) const

inline

Definition at line 148 of file qquickevents_p_p.h.

Property Documentation

◆ accepted

bool QQuickMouseEvent::accepted

readwrite

Definition at line 120 of file qquickevents_p_p.h.

◆ button

int QQuickMouseEvent::button

read

Definition at line 112 of file qquickevents_p_p.h.

◆ buttons

int QQuickMouseEvent::buttons

read

Definition at line 113 of file qquickevents_p_p.h.

◆ flags

int QQuickMouseEvent::flags

read

Definition at line 121 of file qquickevents_p_p.h.

◆ isClick

bool QQuickMouseEvent::isClick

read

Definition at line 118 of file qquickevents_p_p.h.

◆ modifiers

int QQuickMouseEvent::modifiers

read

Definition at line 114 of file qquickevents_p_p.h.

◆ wasHeld

bool QQuickMouseEvent::wasHeld

read

Definition at line 119 of file qquickevents_p_p.h.

◆ x

qreal QQuickMouseEvent::x

read

Definition at line 110 of file qquickevents_p_p.h.

◆ y

qreal QQuickMouseEvent::y

read

Definition at line 111 of file qquickevents_p_p.h.

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

qtdeclarative/src/quick/items/qquickevents_p_p.h (01cd43d30e3ca2c4dd94a4a4711604adb9417517)

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickMouseEvent()

Member Function Documentation

◆ button()

◆ buttons()

◆ flags()

◆ isAccepted()

◆ isClick()

◆ modifiers()

◆ reset()

◆ setAccepted()

◆ setPosition()

◆ setX()

◆ setY()

◆ wasHeld()

◆ x()

◆ y()

Property Documentation

◆ accepted

◆ button

◆ buttons

◆ flags

◆ isClick

◆ modifiers

◆ wasHeld

◆ x

◆ y