KWayland

View on LXR

KWayland
Server
Display

#include <display.h>

Inheritance diagram for KWayland::Server::Display:

Public Types
enum	StartMode { ConnectToSocket, ConnectClientsOnly }

Properties
bool	automaticSocketNaming

bool	running

QString	socketName

Properties inherited from QObject
	objectName

Signals
void	aboutToTerminate ()

void	automaticSocketNamingChanged (bool)

void	clientConnected (KWayland::Server::ClientConnection *)

void	clientDisconnected (KWayland::Server::ClientConnection *)

void	runningChanged (bool)

void	socketNameChanged (const QString &)

Public Member Functions
	Display (QObject *parent=nullptr)

bool	automaticSocketNaming () const

QVector< ClientConnection * >	connections () const

AppMenuManagerInterface *	createAppMenuManagerInterface (QObject *parent=nullptr)

BlurManagerInterface *	createBlurManager (QObject *parent=nullptr)

ClientConnection *	createClient (int fd)

CompositorInterface *	createCompositor (QObject *parent=nullptr)

ContrastManagerInterface *	createContrastManager (QObject *parent=nullptr)

DataDeviceManagerInterface *	createDataDeviceManager (QObject *parent=nullptr)

DpmsManagerInterface *	createDpmsManager (QObject *parent=nullptr)

EglStreamControllerInterface *	createEglStreamControllerInterface (QObject *parent=nullptr)

FakeInputInterface *	createFakeInput (QObject *parent=nullptr)

IdleInterface *	createIdle (QObject *parent=nullptr)

IdleInhibitManagerInterface *	createIdleInhibitManager (const IdleInhibitManagerInterfaceVersion &version, QObject *parent=nullptr)

KeyStateInterface *	createKeyStateInterface (QObject *parent=nullptr)

LinuxDmabufUnstableV1Interface *	createLinuxDmabufInterface (QObject *parent=nullptr)

OutputInterface *	createOutput (QObject *parent=nullptr)

OutputDeviceInterface *	createOutputDevice (QObject *parent=nullptr)

OutputManagementInterface *	createOutputManagement (QObject *parent=nullptr)

PlasmaShellInterface *	createPlasmaShell (QObject *parent=nullptr)

PlasmaVirtualDesktopManagementInterface *	createPlasmaVirtualDesktopManagement (QObject *parent=nullptr)

PlasmaWindowManagementInterface *	createPlasmaWindowManagement (QObject *parent=nullptr)

PointerConstraintsInterface *	createPointerConstraints (const PointerConstraintsInterfaceVersion &version, QObject *parent=nullptr)

PointerGesturesInterface *	createPointerGestures (const PointerGesturesInterfaceVersion &version, QObject *parent=nullptr)

QtSurfaceExtensionInterface *	createQtSurfaceExtension (QObject *parent=nullptr)

RelativePointerManagerInterface *	createRelativePointerManager (const RelativePointerInterfaceVersion &version, QObject *parent=nullptr)

RemoteAccessManagerInterface *	createRemoteAccessManager (QObject *parent=nullptr)

SeatInterface *	createSeat (QObject *parent=nullptr)

ServerSideDecorationManagerInterface *	createServerSideDecorationManager (QObject *parent=nullptr)

ServerSideDecorationPaletteManagerInterface *	createServerSideDecorationPaletteManager (QObject *parent=nullptr)

ShadowManagerInterface *	createShadowManager (QObject *parent=nullptr)

ShellInterface *	createShell (QObject *parent=nullptr)

void	createShm ()

SlideManagerInterface *	createSlideManager (QObject *parent=nullptr)

SubCompositorInterface *	createSubCompositor (QObject *parent=nullptr)

TextInputManagerInterface *	createTextInputManager (const TextInputInterfaceVersion &version, QObject *parent=nullptr)

XdgDecorationManagerInterface *	createXdgDecorationManager (XdgShellInterface shellInterface, QObject parent=nullptr)

XdgForeignInterface *	createXdgForeignInterface (QObject *parent=nullptr)

XdgOutputManagerInterface *	createXdgOutputManager (QObject *parent=nullptr)

XdgShellInterface *	createXdgShell (const XdgShellInterfaceVersion &version, QObject *parent=nullptr)

void	dispatchEvents (int msecTimeout=-1)

void *	eglDisplay () const

ClientConnection *	getConnection (wl_client *client)

bool	isRunning () const

quint32	nextSerial ()

	operator wl_display * ()

	operator wl_display * () const

QList< OutputDeviceInterface * >	outputDevices () const

QList< OutputInterface * >	outputs () const

void	removeOutput (OutputInterface *output)

void	removeOutputDevice (OutputDeviceInterface *output)

QVector< SeatInterface * >	seats () const

quint32	serial ()

void	setAutomaticSocketNaming (bool automaticSocketNaming)

void	setEglDisplay (void *display)

void	setSocketName (const QString &name)

QString	socketName () const

void	start (StartMode mode=StartMode::ConnectToSocket)

void	startLoop ()

void	terminate ()

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

Class holding the Wayland server display loop.

Todo:: Improve documentation

Definition at line 102 of file display.h.

Member Enumeration Documentation

enum KWayland::Server::Display::StartMode

strong

How to setup the server connection.

ConnectToSocket: the server will open the socket identified by the socket name
ConnectClientsOnly: only connections through createClient are possible

Definition at line 136 of file display.h.

Member Function Documentation

AppMenuManagerInterface * KWayland::Server::Display::createAppMenuManagerInterface ( QObject * parent = nullptr )

Creates the AppMenuManagerInterface in interface version.

Returns: The created manager object

Since: 5.42

Definition at line 484 of file display.cpp.

ClientConnection * KWayland::Server::Display::createClient ( int fd )

Create a client for the given file descriptor.

The client is created as if it connected through the normal server socket. This method can be used to create a connection bypassing the normal socket connection. It's recommended to use together with socketpair and pass the other side of the socket to the client.

Parameters

fd	The file descriptor for the socket to the client

Returns: The new ClientConnection or null on failure.

Definition at line 630 of file display.cpp.

EglStreamControllerInterface * KWayland::Server::Display::createEglStreamControllerInterface ( QObject * parent = nullptr )

Creates the EglStreamControllerInterface.

Returns: the created EGL Stream controller

Since: 5.58

Definition at line 526 of file display.cpp.

IdleInhibitManagerInterface * KWayland::Server::Display::createIdleInhibitManager	(	const IdleInhibitManagerInterfaceVersion &	version,
		QObject *	parent = `nullptr`
	)

Creates the IdleInhibitManagerInterface in interface version.

Returns: The created manager object

Since: 5.41

Definition at line 472 of file display.cpp.

KeyStateInterface * KWayland::Server::Display::createKeyStateInterface ( QObject * parent = nullptr )

Since: 5.60

Definition at line 533 of file display.cpp.

LinuxDmabufUnstableV1Interface * KWayland::Server::Display::createLinuxDmabufInterface ( QObject * parent = nullptr )

Creates the LinuxDmabufUnstableV1Interface in interface version.

Returns: A pointer to the created interface

Definition at line 498 of file display.cpp.

PlasmaVirtualDesktopManagementInterface * KWayland::Server::Display::createPlasmaVirtualDesktopManagement ( QObject * parent = nullptr )

Creates the PlasmaVirtualDesktopManagementInterface in interface version.

Returns: The created manager object

Since: 5.52

Definition at line 505 of file display.cpp.

PointerConstraintsInterface * KWayland::Server::Display::createPointerConstraints	(	const PointerConstraintsInterfaceVersion &	version,
		QObject *	parent = `nullptr`
	)

Creates the PointerConstraintsInterface in interface version.

Returns: The created manager object

Since: 5.29

Definition at line 453 of file display.cpp.

PointerGesturesInterface * KWayland::Server::Display::createPointerGestures	(	const PointerGesturesInterfaceVersion &	version,
		QObject *	parent = `nullptr`
	)

Creates the PointerGesturesInterface in interface version.

Returns: The created manager object

Since: 5.29

Definition at line 441 of file display.cpp.

RelativePointerManagerInterface * KWayland::Server::Display::createRelativePointerManager	(	const RelativePointerInterfaceVersion &	version,
		QObject *	parent = `nullptr`
	)

Creates the RelativePointerManagerInterface in interface version.

Returns: The created manager object

Since: 5.28

Definition at line 429 of file display.cpp.

ServerSideDecorationManagerInterface * KWayland::Server::Display::createServerSideDecorationManager ( QObject * parent = nullptr )

Since: 5.6

Definition at line 387 of file display.cpp.

ServerSideDecorationPaletteManagerInterface * KWayland::Server::Display::createServerSideDecorationPaletteManager ( QObject * parent = nullptr )

Creates the ServerSideDecorationPaletteManagerInterface in interface version.

Returns: The created manager object

Since: 5.42

Definition at line 491 of file display.cpp.

TextInputManagerInterface * KWayland::Server::Display::createTextInputManager	(	const TextInputInterfaceVersion &	version,
		QObject *	parent = `nullptr`
	)

Create the text input manager in interface version.

Returns: The created manager object

Since: 5.23

Definition at line 394 of file display.cpp.

XdgDecorationManagerInterface * KWayland::Server::Display::createXdgDecorationManager	(	XdgShellInterface *	shellInterface,
		QObject *	parent = `nullptr`
	)

Creates the XdgDecorationManagerInterface.

shellInterface A created XdgShellInterface based on XDG_WM_BASE

Returns: the created manager

Since: 5.54

Definition at line 519 of file display.cpp.

XdgForeignInterface * KWayland::Server::Display::createXdgForeignInterface ( QObject * parent = nullptr )

Creates the XdgForeignInterface in interface version.

Returns: The created manager object

Since: 5.40

Definition at line 465 of file display.cpp.

XdgOutputManagerInterface * KWayland::Server::Display::createXdgOutputManager ( QObject * parent = nullptr )

Creates the XdgOutputManagerInterface.

Returns: the created manager

Since: 5.47

Definition at line 512 of file display.cpp.

XdgShellInterface * KWayland::Server::Display::createXdgShell	(	const XdgShellInterfaceVersion &	version,
		QObject *	parent = `nullptr`
	)

Creates the XdgShell in interface version.

Since: 5.25

Definition at line 411 of file display.cpp.

void KWayland::Server::Display::dispatchEvents ( int msecTimeout = -1 )

Dispatches pending events in a blocking way.

May only be used if the Display is created and started before the QCoreApplication is created. Once the QCoreApplication is created and the event loop is started this method delegates to the normal dispatch handling.

See also: startLoop

Definition at line 217 of file display.cpp.

void * KWayland::Server::Display::eglDisplay ( ) const

Returns: the EGLDisplay used for this Wayland display or EGL_NO_DISPLAY if not set.

See also: setEglDisplay

Since: 5.3

Definition at line 650 of file display.cpp.

ClientConnection * KWayland::Server::Display::getConnection ( wl_client * client )

Gets the ClientConnection for the given client.

If there is no ClientConnection yet for the given client, it will be created.

Parameters

client The native client for which the ClientConnection is retrieved

Returns: The ClientConnection for the given native client

Definition at line 598 of file display.cpp.

QVector< SeatInterface * > KWayland::Server::Display::seats ( ) const

Returns: All SeatInterface currently managed on the Display.

Since: 5.6

Definition at line 593 of file display.cpp.

void KWayland::Server::Display::setAutomaticSocketNaming ( bool automaticSocketNaming )

If automaticSocketNaming is true, the manually set socketName is ignored and it will use wl_display_add_socket_auto on start to get a free socket with a filename "wayland-%d" instead.

The effective socket is written into socketName.

Since: 5.55

Definition at line 168 of file display.cpp.

void KWayland::Server::Display::setEglDisplay ( void * display )

Set the EGL display for this Wayland display.

The EGLDisplay can only be set once and must be alive as long as the Wayland display is alive. The user should have set up the binding between the EGLDisplay and the Wayland display prior to calling this method.

See also: eglDisplay

Since: 5.3

Definition at line 641 of file display.cpp.

void KWayland::Server::Display::setSocketName ( const QString & name )

Sets the basename of the socket to name.

If name is empty, it will use wl_display_add_socket_auto to get a free socket with a filename "wayland-%d".

Definition at line 154 of file display.cpp.

void KWayland::Server::Display::startLoop ( )

Starts the event loop for the server socket.

This method should only be used if start() is used before creating the QCoreApplication. In that case start() cannot fully setup the event processing and the loop needs to be started after the QCoreApplication got created.

See also: start; dispatchEvents

Definition at line 210 of file display.cpp.

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

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

Public Types

Properties

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation