KWaylandServer::Display

Search for usage in LXR

KWaylandServer::Display Class Reference

#include <display.h>

Inheritance diagram for KWaylandServer::Display:

Properties

bool running
 
- Properties inherited from QObject
 objectName
 

Signals

void clientConnected (KWaylandServer::ClientConnection *)
 
void clientDisconnected (KWaylandServer::ClientConnection *)
 
void runningChanged (bool)
 
void socketNamesChanged ()
 

Public Member Functions

 Display (QObject *parent=nullptr)
 
bool addSocketFileDescriptor (int fileDescriptor)
 
bool addSocketName (const QString &name=QString())
 
QVector< ClientConnection * > connections () const
 
ClientConnectioncreateClient (int fd)
 
void createShm ()
 
void dispatchEvents ()
 
void * eglDisplay () const
 
ClientConnectiongetConnection (wl_client *client)
 
bool isRunning () const
 
quint32 nextSerial ()
 
 operator wl_display * ()
 
 operator wl_display * () const
 
QList< OutputDeviceInterface * > outputDevices () const
 
QList< OutputInterface * > outputs () const
 
QVector< SeatInterface * > seats () const
 
quint32 serial ()
 
void setEglDisplay (void *display)
 
QStringList socketNames () const
 
bool start ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
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)
 
qobject_cast (QObject *object)
 
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)
 
QThreadthread () 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
 
QObjectsender () 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 48 of file display.h.

Member Function Documentation

bool KWaylandServer::Display::addSocketFileDescriptor ( int  fileDescriptor)

Adds a socket with the given fileDescriptor to the Wayland display.

This function returns true if the socket has been added successfully; otherwise returns false.

The compositor can call this function even after the display has been started.

See also
start()

Definition at line 48 of file display.cpp.

bool KWaylandServer::Display::addSocketName ( const QString name = QString())

Adds a UNIX socket with the specified name to the Wayland display.

This function returns true if the socket has been added successfully; otherwise returns false.

If the specified socket name name is empty, the display will pick a free socket with a filename "wayland-%d".

The compositor can call this function even after the display has been started.

See also
start()

Definition at line 57 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 195 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 215 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 163 of file display.cpp.

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

Definition at line 158 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 206 of file display.cpp.

QStringList KWaylandServer::Display::socketNames ( ) const

Returns the list of socket names that the display listens for client connections.

Definition at line 76 of file display.cpp.

bool KWaylandServer::Display::start ( )

Start accepting client connections.

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

Definition at line 81 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-2021 The KDE developers.
Generated on Thu Mar 4 2021 23:09:08 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.