KWayland::Client::Seat

View on LXR

KWayland
Client
Seat

#include <seat.h>

Inheritance diagram for KWayland::Client::Seat:

Properties
bool	keyboard

QString	name

bool	pointer

bool	touch

Properties inherited from QObject
	objectName

Signals
void	hasKeyboardChanged (bool)

void	hasPointerChanged (bool)

void	hasTouchChanged (bool)

void	interfaceAboutToBeDestroyed ()

void	interfaceAboutToBeReleased ()

void	nameChanged (const QString &name)

void	removed ()

Public Member Functions
	Seat (QObject *parent=nullptr)

Keyboard *	createKeyboard (QObject *parent=nullptr)

Pointer *	createPointer (QObject *parent=nullptr)

Touch *	createTouch (QObject *parent=nullptr)

void	destroy ()

EventQueue *	eventQueue ()

bool	hasKeyboard () const

bool	hasPointer () const

bool	hasTouch () const

bool	isValid () const

QString	name () const

	operator wl_seat * ()

	operator wl_seat * () const

void	release ()

void	setEventQueue (EventQueue *queue)

void	setup (wl_seat *seat)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

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

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

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

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

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

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

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

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Wrapper for the wl_seat interface.

This class provides a convenient wrapper for the wl_seat interface. It's main purpose is to provide the interfaces for Keyboard, Pointer and Touch.

To use this class one needs to interact with the Registry. There are two possible ways to create the Seat interface:

Seat *s = registry->createSeat(name, version);

This creates the Seat and sets it up directly. As an alternative this can also be done in a more low level way:

Seat *s = new Seat;

s->setup(registry->bindSeat(name, version));

The Seat can be used as a drop-in replacement for any wl_seat pointer as it provides matching cast operators.

See also: Registry; Keyboard; Pointer

Definition at line 52 of file seat.h.

Property Documentation

bool KWayland::Client::Seat::keyboard

read

The seat has pointer devices.

Default value is false.

Definition at line 58 of file seat.h.

QString KWayland::Client::Seat::name

read

In a multiseat configuration this can be used by the client to help identify which physical devices the seat represents.

Based on the seat configuration used by the compositor.

Definition at line 72 of file seat.h.

bool KWayland::Client::Seat::pointer

read

The seat has pointer devices.

Default value is false.

Definition at line 62 of file seat.h.

bool KWayland::Client::Seat::touch

read

The seat has touch devices.

Default value is false.

Definition at line 66 of file seat.h.

Member Function Documentation

Keyboard * KWayland::Client::Seat::createKeyboard ( QObject * parent = nullptr )

Creates a Keyboard.

This method may only be called if the Seat has a keyboard.

Parameters

parent The parent to pass to the created Keyboard.

Returns: The created Keyboard.

Definition at line 167 of file seat.cpp.

Pointer * KWayland::Client::Seat::createPointer ( QObject * parent = nullptr )

Creates a Pointer.

This method may only be called if the Seat has a pointer.

Parameters

parent The parent to pass to the created Pointer.

Returns: The created Pointer.

Definition at line 182 of file seat.cpp.

Touch * KWayland::Client::Seat::createTouch ( QObject * parent = nullptr )

Creates a Touch.

This method may only be called if the Seat has touch support.

Parameters

parent The parent to pass to the created Touch.

Returns: The created Touch.

Definition at line 197 of file seat.cpp.

void KWayland::Client::Seat::destroy ( )

Destroys the data held by this Seat.

This method is supposed to be used when the connection to the Wayland server goes away. If the connection is not valid anymore, it's not possible to call release anymore as that calls into the Wayland connection and the call would fail. This method cleans up the data, so that the instance can be deleted or set up to a new wl_shell interface once there is a new connection available.

This method is automatically invoked when the Registry which created this Seat gets destroyed.

Right before the data is destroyed the signal interfaceAboutToBeDestroyed is emitted.

See also: release; interfaceAboutToBeDestroyed

Definition at line 86 of file seat.cpp.

EventQueue * KWayland::Client::Seat::eventQueue ( )

Returns: The event queue to use for creating Keyboard, Pointer and Touch.

Definition at line 101 of file seat.cpp.

void KWayland::Client::Seat::interfaceAboutToBeDestroyed ( )

signal

This signal is emitted right before the data is going to be destroyed.

void KWayland::Client::Seat::interfaceAboutToBeReleased ( )

signal

This signal is emitted right before the interface is going to be released.

bool KWayland::Client::Seat::isValid ( ) const

Returns: true if managing a wl_seat.

Definition at line 221 of file seat.cpp.

void KWayland::Client::Seat::release ( )

Releases the wl_seat interface.

After the interface has been released the Seat instance is no longer valid and can be setup with another wl_seat interface.

Right before the interface is released the signal interfaceAboutToBeReleased is emitted.

See also: interfaceAboutToBeReleased

Definition at line 76 of file seat.cpp.

void KWayland::Client::Seat::removed ( )

signal

The corresponding global for this interface on the Registry got removed.

This signal gets only emitted if the Compositor got created by Registry::createSeat

Since: 5.5

void KWayland::Client::Seat::setEventQueue ( EventQueue * queue )

Sets the queue to use for creating Keyboard, Pointer and Touch.

Definition at line 96 of file seat.cpp.

void KWayland::Client::Seat::setup ( wl_seat * seat )

Setup this Seat to manage the seat.

When using Registry::createSeat there is no need to call this method.

Definition at line 141 of file seat.cpp.

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

KDE's Doxygen guidelines are available online.

KWayland::Client::Seat

Properties

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

Member Function Documentation