KWayland::Client::Compositor

KWayland::Client::Compositor Class Reference

#include <compositor.h>

Inheritance diagram for KWayland::Client::Compositor:

Signals

void removed ()
 

Public Member Functions

 Compositor (QObject *parent=nullptr)
 
RegioncreateRegion (QObject *parent=nullptr)
 
RegioncreateRegion (const QRegion &region, QObject *parent)
 
std::unique_ptr< RegioncreateRegion (const QRegion &region)
 
SurfacecreateSurface (QObject *parent=nullptr)
 
void destroy ()
 
EventQueueeventQueue ()
 
bool isValid () const
 
 operator wl_compositor * ()
 
 operator wl_compositor * () const
 
void release ()
 
void setEventQueue (EventQueue *queue)
 
void setup (wl_compositor *compositor)
 
- 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
 

Static Public Member Functions

static CompositorfromApplication (QObject *parent=nullptr)
 
- 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)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- 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

Wrapper for the wl_compositor interface.

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

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

Compositor *c = registry->createCompositor(name, version);

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

c->setup(registry->bindCompositor(name, version));

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

See also
Registry

Definition at line 50 of file compositor.h.

Constructor & Destructor Documentation

KWayland::Client::Compositor::Compositor ( QObject parent = nullptr)
explicit

Creates a new Compositor.

Note: after constructing the Compositor it is not yet valid and one needs to call setup. In order to get a ready to use Compositor prefer using Registry::createCompositor.

Definition at line 32 of file compositor.cpp.

Member Function Documentation

Region * KWayland::Client::Compositor::createRegion ( QObject parent = nullptr)

Creates and setup a new Region with parent.

Parameters
parentThe parent to pass to the Region.
Returns
The new created Region

Definition at line 97 of file compositor.cpp.

Region * KWayland::Client::Compositor::createRegion ( const QRegion region,
QObject parent 
)

Creates and setup a new Region with parent.

The region is directly added to the created Region.

Parameters
parentThe parent to pass to the Region.
regionThe region to install on the newly created Region
Returns
The new created Region

Definition at line 102 of file compositor.cpp.

std::unique_ptr< Region > KWayland::Client::Compositor::createRegion ( const QRegion region)

Creates and setup a new Region with region installed.

This overloaded convenience method is intended to be used in the case that the Region is only needed to setup e.g. input region on a Surface and is afterwards no longer needed. Setting the input region has copy semantics and the Region can be destroyed afterwards. This allows to simplify setting the input region to:

Surface *s = compositor->createSurface();
s->setInputRegion(compositor->createRegion(QRegion(0, 0, 10, 10)).get());
Parameters
regionThe region to install on the newly created Region
Returns
The new created Region

Definition at line 114 of file compositor.cpp.

Surface * KWayland::Client::Compositor::createSurface ( QObject parent = nullptr)

Creates and setup a new Surface with parent.

Parameters
parentThe parent to pass to the Surface.
Returns
The new created Surface

Definition at line 85 of file compositor.cpp.

void KWayland::Client::Compositor::destroy ( )

Destroys the data held by this Compositor.

This method is supposed to be used when the connection to the Wayland server goes away. If the connection is not valid anymore, 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_compositor interface once there is a new connection available.

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

See also
release

Definition at line 70 of file compositor.cpp.

EventQueue * KWayland::Client::Compositor::eventQueue ( )
Returns
The event queue to use for creating a Surface.

Definition at line 80 of file compositor.cpp.

Compositor * KWayland::Client::Compositor::fromApplication ( QObject parent = nullptr)
static

Creates a Compositor for the used QGuiApplication.

This is an integration feature for QtWayland. On non-wayland platforms this method returns nullptr.

The returned Compositor will be fully setup, which means it manages a wl_compositor. When the created Compositor gets destroyed the managed wl_compositor won't be disconnected as that's managed by Qt.

Since
5.4

Definition at line 43 of file compositor.cpp.

bool KWayland::Client::Compositor::isValid ( ) const
Returns
true if managing a wl_compositor.

Definition at line 127 of file compositor.cpp.

void KWayland::Client::Compositor::release ( )

Releases the wl_compositor interface.

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

Definition at line 65 of file compositor.cpp.

void KWayland::Client::Compositor::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::createCompositor

Since
5.5
void KWayland::Client::Compositor::setEventQueue ( EventQueue queue)

Sets the queue to use for creating a Surface.

Definition at line 75 of file compositor.cpp.

void KWayland::Client::Compositor::setup ( wl_compositor *  compositor)

Setup this Compositor to manage the compositor.

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

Definition at line 58 of file compositor.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 Wed Sep 23 2020 22:50:44 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.