KWayland::Client::Shell Class Reference

#include <shell.h>

Inheritance diagram for KWayland::Client::Shell:

Signals
void	interfaceAboutToBeDestroyed ()
void	interfaceAboutToBeReleased ()
void	removed ()

Public Member Functions
	Shell (QObject *parent=nullptr)
ShellSurface *	createSurface (wl_surface *surface, QObject *parent=nullptr)
ShellSurface *	createSurface (Surface *surface, QObject *parent=nullptr)
void	destroy ()
EventQueue *	eventQueue ()
bool	isValid () const
	operator wl_shell * ()
	operator wl_shell * () const
void	release ()
void	setEventQueue (EventQueue *queue)
void	setup (wl_shell *shell)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () const

Additional Inherited Members
Properties inherited from QObject
	objectName
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)
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
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Wrapper for the wl_shell interface.

This class provides a convenient wrapper for the wl_shell interface. It's main purpose is to create a ShellSurface.

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

Shell *s = registry->createShell(name, version);

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

Shell *s = new Shell;
s->setup(registry->bindShell(name, version));

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

See also

Registry

ShellSurface

Definition at line 69 of file shell.h.

Member Function Documentation

ShellSurface * KWayland::Client::Shell::createSurface	(	wl_surface *	surface,
		QObject *	parent = nullptr
	)

Creates a ShellSurface for the given surface and sets it up.

Parameters

surface	The native surface to create the ShellSurface for
parent	The parent to use for the ShellSurface

Returns

created ShellSurface

Definition at line 92 of file shell.cpp.

ShellSurface * KWayland::Client::Shell::createSurface	(	Surface *	surface,
		QObject *	parent = nullptr
	)

Creates a ShellSurface for the given surface and sets it up.

Parameters

surface	The Surface to create the ShellSurface for
parent	The parent to use for the ShellSurface

Returns

created ShellSurface

Definition at line 106 of file shell.cpp.

void KWayland::Client::Shell::destroy

(

)

Destroys the data held by this Shell.

This method is supposed to be used when the connection to the Wayland server goes away. Once the connection becomes invalid, 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.

It is suggested to connect this method to ConnectionThread::connectionDied:

connect(connection, &ConnectionThread::connectionDied, shell, &Shell::destroy);

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

See also

release

interfaceAboutToBeDestroyed

Definition at line 57 of file shell.cpp.

EventQueue * KWayland::Client::Shell::eventQueue

(

)

Returns

The event queue to use for creating a Surface.

Definition at line 87 of file shell.cpp.

void KWayland::Client::Shell::interfaceAboutToBeDestroyed ( )

signal

This signal is emitted right before the data is destroyed.

void KWayland::Client::Shell::interfaceAboutToBeReleased ( )

signal

This signal is emitted right before the interface is released.

bool KWayland::Client::Shell::isValid

(

)

const

Returns

true if managing a wl_shell.

Definition at line 112 of file shell.cpp.

void KWayland::Client::Shell::release

(

)

Releases the wl_shell interface.

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

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

See also

interfaceAboutToBeReleased

Definition at line 66 of file shell.cpp.

void KWayland::Client::Shell::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::createShell

Since

5.5

void KWayland::Client::Shell::setEventQueue

(

EventQueue *

queue

)

Sets the queue to use for creating a Surface.

Definition at line 82 of file shell.cpp.

void KWayland::Client::Shell::setup

(

wl_shell *

shell

)

Setup this Shell to manage the shell.

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

Definition at line 75 of file shell.cpp.

---

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

• shell.h
• shell.cpp