\inmodule QtWaylandCompositor More...

#include <qwaylandkeyboard.h>

Inheritance diagram for QWaylandKeyboard:

Collaboration diagram for QWaylandKeyboard:

Signals
void	focusChanged (QWaylandSurface *surface)

void	repeatRateChanged (quint32 repeatRate)

void	repeatDelayChanged (quint32 repeatDelay)

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
	QWaylandKeyboard (QWaylandSeat seat, QObject parent=nullptr)
	Constructs a QWaylandKeyboard for the given seat and with the given parent.

QWaylandSeat *	seat () const
	Returns the seat for this QWaylandKeyboard.

QWaylandCompositor *	compositor () const
	Returns the compositor for this QWaylandKeyboard.

quint32	repeatRate () const
	Returns the current repeat rate.

void	setRepeatRate (quint32 rate)
	Sets the repeat rate to rate.

quint32	repeatDelay () const
	Returns the current repeat delay.

void	setRepeatDelay (quint32 delay)
	Sets the repeat delay to delay.

virtual void	setFocus (QWaylandSurface *surface)
	Sets the current focus to surface.

virtual void	sendKeyModifiers (QWaylandClient *client, uint32_t serial)
	Sends the current key modifiers to client with the given serial.

virtual void	sendKeyPressEvent (uint code)
	Sends a key press event with the key code to the current keyboard focus.

virtual void	sendKeyReleaseEvent (uint code)
	Sends a key release event with the key code to the current keyboard focus.

QWaylandSurface *	focus () const
	Returns the currently focused surface.

QWaylandClient *	focusClient () const
	Returns the client that currently has keyboard focus.

virtual void	addClient (QWaylandClient *client, uint32_t id, uint32_t version)

uint	keyToScanCode (int qtKey) const

Public Member Functions inherited from QWaylandObject
	~QWaylandObject () override

QWaylandCompositorExtension *	extension (const QByteArray &name)
	Returns the compositor extension which matches name if one has been registered with the QWaylandObject.

QWaylandCompositorExtension *	extension (const wl_interface *interface)
	Returns the compositor extension which matches interface if one has been registered with the QWaylandObject.

QList< QWaylandCompositorExtension * >	extensions () const
	Returns the list of compositor extensions that have been registered with this QWaylandObject.

void	addExtension (QWaylandCompositorExtension *extension)
	Registers extension with this QWaylandObject.

void	removeExtension (QWaylandCompositorExtension *extension)
	Removes extension from the list of registered extensions in this QWaylandObject, if it has previously been registered using \l{addExtension()}.

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	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
quint32	repeatRate

quint32	repeatDelay

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 Member Functions inherited from QWaylandObject
	QWaylandObject (QObject *parent=nullptr)
	Creates a QWaylandObject as a child of parent.

	QWaylandObject (QObjectPrivate &d, QObject *parent=nullptr)

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 QWaylandObject
QList< QWaylandCompositorExtension * >	extension_vector

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

\inmodule QtWaylandCompositor

Since: 5.8

The QWaylandKeyboard class represents a keyboard device.

This class provides access to the keyboard device in a QWaylandSeat. It corresponds to the Wayland interface wl_keyboard.

Definition at line 20 of file qwaylandkeyboard.h.

Constructor & Destructor Documentation

◆ QWaylandKeyboard()

QWaylandKeyboard::QWaylandKeyboard	(	QWaylandSeat *	seat,
		QObject *	parent = nullptr )

Constructs a QWaylandKeyboard for the given seat and with the given parent.

Definition at line 420 of file qwaylandkeyboard.cpp.

Member Function Documentation

◆ addClient()

void QWaylandKeyboard::addClient	(	QWaylandClient *	client,
		uint32_t	id,
		uint32_t	version )

virtual

Definition at line 617 of file qwaylandkeyboard.cpp.

◆ compositor()

QWaylandCompositor * QWaylandKeyboard::compositor ( ) const

Returns the compositor for this QWaylandKeyboard.

Definition at line 448 of file qwaylandkeyboard.cpp.

◆ focus()

QWaylandSurface * QWaylandKeyboard::focus ( ) const

Returns the currently focused surface.

Definition at line 599 of file qwaylandkeyboard.cpp.

◆ focusChanged

void QWaylandKeyboard::focusChanged ( QWaylandSurface * surface )

signal

◆ focusClient()

QWaylandClient * QWaylandKeyboard::focusClient ( ) const

Returns the client that currently has keyboard focus.

Definition at line 477 of file qwaylandkeyboard.cpp.

◆ keyToScanCode()

uint QWaylandKeyboard::keyToScanCode ( int qtKey ) const

Definition at line 623 of file qwaylandkeyboard.cpp.

◆ repeatDelay()

quint32 QWaylandKeyboard::repeatDelay ( ) const

Returns the current repeat delay.

Definition at line 574 of file qwaylandkeyboard.cpp.

◆ repeatDelayChanged

void QWaylandKeyboard::repeatDelayChanged ( quint32 repeatDelay )

signal

◆ repeatRate()

quint32 QWaylandKeyboard::repeatRate ( ) const

Returns the current repeat rate.

Definition at line 549 of file qwaylandkeyboard.cpp.

◆ repeatRateChanged

void QWaylandKeyboard::repeatRateChanged ( quint32 repeatRate )

signal

◆ seat()

QWaylandSeat * QWaylandKeyboard::seat ( ) const

Returns the seat for this QWaylandKeyboard.

Definition at line 439 of file qwaylandkeyboard.cpp.

◆ sendKeyModifiers()

void QWaylandKeyboard::sendKeyModifiers	(	QWaylandClient *	client,
		uint32_t	serial )

virtual

Sends the current key modifiers to client with the given serial.

Definition at line 488 of file qwaylandkeyboard.cpp.

◆ sendKeyPressEvent()

void QWaylandKeyboard::sendKeyPressEvent ( uint code )

virtual

Sends a key press event with the key code to the current keyboard focus.

Definition at line 499 of file qwaylandkeyboard.cpp.

◆ sendKeyReleaseEvent()

void QWaylandKeyboard::sendKeyReleaseEvent ( uint code )

virtual

Sends a key release event with the key code to the current keyboard focus.

Definition at line 508 of file qwaylandkeyboard.cpp.

◆ setFocus()

void QWaylandKeyboard::setFocus ( QWaylandSurface * surface )

virtual

Sets the current focus to surface.

Definition at line 608 of file qwaylandkeyboard.cpp.

◆ setRepeatDelay()

void QWaylandKeyboard::setRepeatDelay ( quint32 delay )

Sets the repeat delay to delay.

Definition at line 583 of file qwaylandkeyboard.cpp.

◆ setRepeatRate()

void QWaylandKeyboard::setRepeatRate ( quint32 rate )

Sets the repeat rate to rate.

Definition at line 558 of file qwaylandkeyboard.cpp.

Property Documentation

◆ repeatDelay

quint32 QWaylandKeyboard::repeatDelay

readwrite

Definition at line 25 of file qwaylandkeyboard.h.

◆ repeatRate

quint32 QWaylandKeyboard::repeatRate

readwrite

Definition at line 24 of file qwaylandkeyboard.h.

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

qtwayland/src/compositor/compositor_api/qwaylandkeyboard.h (811f060c37a58580e0697d0beb34a6f91efeeb41)
qtwayland/src/compositor/compositor_api/qwaylandkeyboard.cpp (c62b27346144945ac6ad37167548e705b9b2cbfa)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QWaylandKeyboard()

Member Function Documentation

◆ addClient()

◆ compositor()

◆ focus()

◆ focusChanged

◆ focusClient()

◆ keyToScanCode()

◆ repeatDelay()

◆ repeatDelayChanged

◆ repeatRate()

◆ repeatRateChanged

◆ seat()

◆ sendKeyModifiers()

◆ sendKeyPressEvent()

◆ sendKeyReleaseEvent()

◆ setFocus()

◆ setRepeatDelay()

◆ setRepeatRate()

Property Documentation

◆ repeatDelay

◆ repeatRate