\qmltype WaylandClient \nativetype QWaylandClient \inqmlmodule QtWayland.Compositor More...

#include <qwaylandclient.h>

Inheritance diagram for QWaylandClient:

Collaboration diagram for QWaylandClient:

Public Types
enum	TextInputProtocol { NoProtocol = 0 , QtTextInputMethodV1 = 1 , TextInputV2 = 2 , TextInputV3 = 4 , TextInputV4 = TextInputV3 , QtTextInputMethod = QtTextInputMethodV1 , TextInput = TextInputV2 }

Public Slots
void	close ()
	\qmlmethod void QtWayland.Compositor::WaylandClient::close()

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Public Member Functions
	~QWaylandClient () override
	Destroys the QWaylandClient.

TextInputProtocols	textInputProtocols () const

void	setTextInputProtocols (TextInputProtocols p)

QWaylandCompositor *	compositor () const

wl_client *	client () const
	Returns the Wayland client of this QWaylandClient.

qint64	userId () const

qint64	groupId () const

qint64	processId () const

Q_INVOKABLE void	kill (int signal=SIGTERM)
	\qmlmethod void QtWayland.Compositor::WaylandClient::kill(signal)

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`.

Static Public Member Functions
static QWaylandClient *	fromWlClient (QWaylandCompositor compositor, wl_client wlClient)
	Returns the QWaylandClient corresponding to the Wayland client wlClient and compositor.

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)

Properties
QWaylandCompositor *	compositor
	\qmlproperty WaylandCompositor QtWayland.Compositor::WaylandClient::compositor

qint64	userId
	\qmlproperty int QtWayland.Compositor::WaylandClient::userId

qint64	groupId
	\qmlproperty int QtWayland.Compositor::WaylandClient::groupId \readonly

qint64	processId
	\qmlproperty int QtWayland.Compositor::WaylandClient::processId \readonly

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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.

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

\qmltype WaylandClient \nativetype QWaylandClient \inqmlmodule QtWayland.Compositor

Since: 5.8

Represents a client connecting to the WaylandCompositor.

This type represents a client connecting to the compositor using the Wayland protocol. It corresponds to the Wayland interface wl_client.

\inmodule QtWaylandCompositor

Since: 5.8

The QWaylandClient class represents a client connecting to the QWaylandCompositor.

This class corresponds to a client connecting to the compositor using the Wayland protocol. It corresponds to the Wayland interface wl_client.

Definition at line 21 of file qwaylandclient.h.

Member Enumeration Documentation

◆ TextInputProtocol

enum QWaylandClient::TextInputProtocol

Enumerator
NoProtocol
QtTextInputMethodV1
TextInputV2
TextInputV3
TextInputV4
QtTextInputMethod
TextInput

Definition at line 38 of file qwaylandclient.h.

Constructor & Destructor Documentation

◆ ~QWaylandClient()

QWaylandClient::~QWaylandClient ( )

override

Destroys the QWaylandClient.

Definition at line 96 of file qwaylandclient.cpp.

Member Function Documentation

◆ client()

wl_client * QWaylandClient::client ( ) const

Returns the Wayland client of this QWaylandClient.

Definition at line 157 of file qwaylandclient.cpp.

◆ close

void QWaylandClient::close ( )

slot

\qmlmethod void QtWayland.Compositor::WaylandClient::close()

Closes the client

Closes the client.

Definition at line 246 of file qwaylandclient.cpp.

◆ compositor()

QWaylandCompositor * QWaylandClient::compositor ( ) const

Definition at line 147 of file qwaylandclient.cpp.

◆ fromWlClient()

QWaylandClient * QWaylandClient::fromWlClient	(	QWaylandCompositor *	compositor,
		wl_client *	wlClient )

static

Returns the QWaylandClient corresponding to the Wayland client wlClient and compositor.

If a QWaylandClient has not already been created for a client, it is created and returned.

Definition at line 111 of file qwaylandclient.cpp.

◆ groupId()

qint64 QWaylandClient::groupId ( ) const

Definition at line 195 of file qwaylandclient.cpp.

◆ kill()

void QWaylandClient::kill ( int signal = SIGTERM )

\qmlmethod void QtWayland.Compositor::WaylandClient::kill(signal)

Kills the client with the specified signal.

Definition at line 230 of file qwaylandclient.cpp.

◆ processId()

qint64 QWaylandClient::processId ( ) const

Definition at line 214 of file qwaylandclient.cpp.

◆ setTextInputProtocols()

void QWaylandClient::setTextInputProtocols ( TextInputProtocols p )

Definition at line 258 of file qwaylandclient.cpp.

◆ textInputProtocols()

QWaylandClient::TextInputProtocols QWaylandClient::textInputProtocols ( ) const

Definition at line 252 of file qwaylandclient.cpp.

◆ userId()

qint64 QWaylandClient::userId ( ) const

Definition at line 176 of file qwaylandclient.cpp.

Property Documentation

◆ compositor

QWaylandCompositor * QWaylandClient::compositor

read

\qmlproperty WaylandCompositor QtWayland.Compositor::WaylandClient::compositor

This property holds the compositor of this WaylandClient.

This property holds the compositor of this QWaylandClient.

Definition at line 26 of file qwaylandclient.h.

◆ groupId

qint64 QWaylandClient::groupId

read

\qmlproperty int QtWayland.Compositor::WaylandClient::groupId \readonly

This property holds the group id of this WaylandClient.

This property holds the group id of this QWaylandClient.

Definition at line 28 of file qwaylandclient.h.

◆ processId

qint64 QWaylandClient::processId

read

\qmlproperty int QtWayland.Compositor::WaylandClient::processId \readonly

This property holds the process id of this WaylandClient.

This property holds the process id of this QWaylandClient.

Definition at line 29 of file qwaylandclient.h.

◆ userId

qint64 QWaylandClient::userId

read

\qmlproperty int QtWayland.Compositor::WaylandClient::userId

This property holds the user id of this WaylandClient.

\readonly

This property holds the user id of this QWaylandClient.

Definition at line 27 of file qwaylandclient.h.

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

qtwayland/src/compositor/compositor_api/qwaylandclient.h (f1f4e26e3b4b022021620ae268fa87788cbfd524)
qtwayland/src/compositor/compositor_api/qwaylandclient.cpp (bc861d37690e29a84c99e295329f2f7f006274f6)

Public Types

Public Slots

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TextInputProtocol

Constructor & Destructor Documentation

◆ ~QWaylandClient()

Member Function Documentation

◆ client()

◆ close

◆ compositor()

◆ fromWlClient()

◆ groupId()

◆ kill()

◆ processId()

◆ setTextInputProtocols()

◆ textInputProtocols()

◆ userId()

Property Documentation

◆ compositor

◆ groupId

◆ processId

◆ userId