KWaylandServer::Display

Public Types | Properties | Signals | Public Member Functions | List of all members
KWaylandServer::Display Class Reference

#include <display.h>

Inheritance diagram for KWaylandServer::Display:
Inheritance graph
[legend]

Public Types

enum  StartMode { ConnectToSocket, ConnectClientsOnly }
 

Properties

bool automaticSocketNaming
 
bool running
 
QString socketName
 
- Properties inherited from QObject
 objectName
 

Signals

void automaticSocketNamingChanged (bool)
 
void clientConnected (KWaylandServer::ClientConnection *)
 
void clientDisconnected (KWaylandServer::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)
 
DataControlDeviceManagerV1Interface * createDataControlDeviceManagerV1 (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)
 
IdleInhibitManagerV1Interface * createIdleInhibitManagerV1 (QObject *parent=nullptr)
 
InputMethodV1Interface * createInputMethodInterface (QObject *parent=nullptr)
 
InputPanelV1Interface * createInputPanelInterface (QObject *parent=nullptr)
 
KeyboardShortcutsInhibitManagerV1Interface * createKeyboardShortcutsInhibitManagerV1 (QObject *parent=nullptr)
 
KeyStateInterface * createKeyStateInterface (QObject *parent=nullptr)
 
LayerShellV1Interface * createLayerShellV1 (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)
 
PointerConstraintsV1Interface * createPointerConstraintsV1 (QObject *parent=nullptr)
 
PointerGesturesV1Interface * createPointerGesturesV1 (QObject *parent=nullptr)
 
PrimarySelectionDeviceManagerV1Interface * createPrimarySelectionDeviceManagerV1 (QObject *parent=nullptr)
 
RelativePointerManagerV1Interface * createRelativePointerManagerV1 (QObject *parent=nullptr)
 
ScreencastV1Interface * createScreencastV1Interface (QObject *parent=nullptr)
 
SeatInterface * createSeat (QObject *parent=nullptr)
 
ServerSideDecorationManagerInterface * createServerSideDecorationManager (QObject *parent=nullptr)
 
ServerSideDecorationPaletteManagerInterface * createServerSideDecorationPaletteManager (QObject *parent=nullptr)
 
ShadowManagerInterface * createShadowManager (QObject *parent=nullptr)
 
void createShm ()
 
SlideManagerInterface * createSlideManager (QObject *parent=nullptr)
 
SubCompositorInterface * createSubCompositor (QObject *parent=nullptr)
 
TabletManagerV2Interface * createTabletManagerV2 (QObject *parent=nullptr)
 
TextInputManagerV2Interface * createTextInputManagerV2 (QObject *parent=nullptr)
 
TextInputManagerV3Interface * createTextInputManagerV3 (QObject *parent=nullptr)
 
ViewporterInterface * createViewporter (QObject *parent=nullptr)
 
XdgDecorationManagerV1Interface * createXdgDecorationManagerV1 (QObject *parent=nullptr)
 
XdgForeignV2Interface * createXdgForeignV2Interface (QObject *parent=nullptr)
 
XdgOutputManagerV1Interface * createXdgOutputManagerV1 (QObject *parent=nullptr)
 
XdgShellInterface * createXdgShell (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
 
bool start (StartMode mode=StartMode::ConnectToSocket)
 
- 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

Class holding the Wayland server display loop.

Todo:
Improve documentation

Definition at line 87 of file display.h.

Member Enumeration Documentation

enum KWaylandServer::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 121 of file display.h.

Member Function Documentation

AppMenuManagerInterface * KWaylandServer::Display::createAppMenuManagerInterface ( QObject *  parent = nullptr)

Creates the AppMenuManagerInterface in interface version.

Returns
The created manager object
Since
5.42

Definition at line 354 of file display.cpp.

ClientConnection * KWaylandServer::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
fdThe file descriptor for the socket to the client
Returns
The new ClientConnection or null on failure.

Definition at line 524 of file display.cpp.

DataControlDeviceManagerV1Interface * KWaylandServer::Display::createDataControlDeviceManagerV1 ( QObject *  parent = nullptr)

Creates the DataControlDeviceManagerV1.

Definition at line 399 of file display.cpp.

EglStreamControllerInterface * KWaylandServer::Display::createEglStreamControllerInterface ( QObject *  parent = nullptr)

Creates the EglStreamControllerInterface.

Returns
the created EGL Stream controller
Since
5.58

Definition at line 384 of file display.cpp.

IdleInhibitManagerV1Interface * KWaylandServer::Display::createIdleInhibitManagerV1 ( QObject *  parent = nullptr)

Creates the IdleInhibitManagerInterface in interface version.

Returns
The created manager object
Since
5.41

Definition at line 349 of file display.cpp.

KeyboardShortcutsInhibitManagerV1Interface * KWaylandServer::Display::createKeyboardShortcutsInhibitManagerV1 ( QObject *  parent = nullptr)

Creates the KeyboardShortcutsInhibitorV1Interface.

Definition at line 404 of file display.cpp.

KeyStateInterface * KWaylandServer::Display::createKeyStateInterface ( QObject *  parent = nullptr)
Since
5.60

Definition at line 389 of file display.cpp.

LayerShellV1Interface * KWaylandServer::Display::createLayerShellV1 ( QObject *  parent = nullptr)

Creates the layer shell compositor extension.

Definition at line 429 of file display.cpp.

LinuxDmabufUnstableV1Interface * KWaylandServer::Display::createLinuxDmabufInterface ( QObject *  parent = nullptr)

Creates the LinuxDmabufUnstableV1Interface in interface version.

Returns
A pointer to the created interface

Definition at line 364 of file display.cpp.

PlasmaVirtualDesktopManagementInterface * KWaylandServer::Display::createPlasmaVirtualDesktopManagement ( QObject *  parent = nullptr)

Creates the PlasmaVirtualDesktopManagementInterface in interface version.

Returns
The created manager object
Since
5.52

Definition at line 369 of file display.cpp.

PointerConstraintsV1Interface * KWaylandServer::Display::createPointerConstraintsV1 ( QObject *  parent = nullptr)

Creates the PointerConstraintsV1Interface.

Returns
The created manager object
Since
5.29

Definition at line 339 of file display.cpp.

PointerGesturesV1Interface * KWaylandServer::Display::createPointerGesturesV1 ( QObject *  parent = nullptr)

Creates the PointerGesturesV1Interface.

Returns
The created manager object
Since
5.29

Definition at line 334 of file display.cpp.

PrimarySelectionDeviceManagerV1Interface * KWaylandServer::Display::createPrimarySelectionDeviceManagerV1 ( QObject *  parent = nullptr)

Creates the PrimarySelectionDeviceManagerV1Interface.

Definition at line 419 of file display.cpp.

RelativePointerManagerV1Interface * KWaylandServer::Display::createRelativePointerManagerV1 ( QObject *  parent = nullptr)

Creates the RelativePointerManagerV1Interface.

Returns
The created manager object
Since
5.28

Definition at line 329 of file display.cpp.

ScreencastV1Interface * KWaylandServer::Display::createScreencastV1Interface ( QObject *  parent = nullptr)

Creates an interface to request video feeds of different compositor resources.

Definition at line 309 of file display.cpp.

ServerSideDecorationManagerInterface * KWaylandServer::Display::createServerSideDecorationManager ( QObject *  parent = nullptr)
Since
5.6

Definition at line 304 of file display.cpp.

ServerSideDecorationPaletteManagerInterface * KWaylandServer::Display::createServerSideDecorationPaletteManager ( QObject *  parent = nullptr)

Creates the ServerSideDecorationPaletteManagerInterface in interface version.

Returns
The created manager object
Since
5.42

Definition at line 359 of file display.cpp.

TabletManagerV2Interface * KWaylandServer::Display::createTabletManagerV2 ( QObject *  parent = nullptr)

Creates the entry point to support wacom-like tablets and pens.

Since
5.67

Definition at line 394 of file display.cpp.

TextInputManagerV2Interface * KWaylandServer::Display::createTextInputManagerV2 ( QObject *  parent = nullptr)

Create the text input manager in interface version.

Returns
The created manager object
Since
5.23

Definition at line 314 of file display.cpp.

TextInputManagerV3Interface * KWaylandServer::Display::createTextInputManagerV3 ( QObject *  parent = nullptr)

Create a text input manager v3.

Returns
The created manager object
Since
5.21

Definition at line 319 of file display.cpp.

ViewporterInterface * KWaylandServer::Display::createViewporter ( QObject *  parent = nullptr)

Creates the viewporter compositor extension.

Definition at line 414 of file display.cpp.

XdgDecorationManagerV1Interface * KWaylandServer::Display::createXdgDecorationManagerV1 ( QObject *  parent = nullptr)

Creates the XdgDecorationManagerInterface.

Returns
the created manager
Since
5.54

Definition at line 379 of file display.cpp.

XdgForeignV2Interface * KWaylandServer::Display::createXdgForeignV2Interface ( QObject *  parent = nullptr)

Creates the XdgForeignV2Interface in interface version.

Returns
The created manager object
Since
5.40

Definition at line 344 of file display.cpp.

XdgOutputManagerV1Interface * KWaylandServer::Display::createXdgOutputManagerV1 ( QObject *  parent = nullptr)

Creates the XdgOutputManagerInterface.

Returns
the created manager
Since
5.47

Definition at line 374 of file display.cpp.

XdgShellInterface * KWaylandServer::Display::createXdgShell ( QObject *  parent = nullptr)

Creates the XdgShell in interface version.

Since
5.25

Definition at line 324 of file display.cpp.

void KWaylandServer::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 197 of file display.cpp.

void * KWaylandServer::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 544 of file display.cpp.

ClientConnection * KWaylandServer::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
clientThe native client for which the ClientConnection is retrieved
Returns
The ClientConnection for the given native client

Definition at line 492 of file display.cpp.

QVector< SeatInterface * > KWaylandServer::Display::seats ( ) const
Returns
All SeatInterface currently managed on the Display.
Since
5.6

Definition at line 487 of file display.cpp.

void KWaylandServer::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 155 of file display.cpp.

void KWaylandServer::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 535 of file display.cpp.

void KWaylandServer::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 141 of file display.cpp.

bool KWaylandServer::Display::start ( StartMode  mode = StartMode::ConnectToSocket)

Start accepting client connections.

If the display has started successfully, this function returns true; otherwise false is returned.

Definition at line 169 of file display.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Nov 30 2020 23:08:58 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.