KWayland::Client::SubCompositor
#include <subcompositor.h>

Signals | |
void | removed () |
Public Member Functions | |
SubCompositor (QObject *parent=nullptr) | |
SubSurface * | createSubSurface (QPointer< Surface > surface, QPointer< Surface > parentSurface, QObject *parent=nullptr) |
void | destroy () |
EventQueue * | eventQueue () |
bool | isValid () const |
operator wl_subcompositor * () | |
operator wl_subcompositor * () const | |
void | release () |
void | setEventQueue (EventQueue *queue) |
void | setup (wl_subcompositor *subcompositor) |
![]() | |
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 QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, 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 ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | qobject_cast (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 | |
![]() | |
objectName | |
![]() | |
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 *context, Functor functor, 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) |
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
typedef | QObjectList |
![]() | |
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
Wrapper for the wl_subcompositor interface.
This class is a convenient wrapper for the wl_subcompositor interface. The main purpose of this class is to create SubSurfaces.
To create an instance use Registry::createSubCompositor.
- See also
- Registry
Definition at line 34 of file subcompositor.h.
Member Function Documentation
◆ createSubSurface()
SubSurface * KWayland::Client::SubCompositor::createSubSurface | ( | QPointer< Surface > | surface, |
QPointer< Surface > | parentSurface, | ||
QObject * | parent = nullptr |
||
) |
Creates and setup a new SubSurface with parent
.
- Parameters
-
parent The parent to pass to the Surface.
- Returns
- The new created Surface
Definition at line 53 of file subcompositor.cpp.
◆ destroy()
void KWayland::Client::SubCompositor::destroy | ( | ) |
Destroys the data held by this SubCompositor.
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_subcompositor interface once there is a new connection available.
- See also
- release
Definition at line 41 of file subcompositor.cpp.
◆ eventQueue()
EventQueue * KWayland::Client::SubCompositor::eventQueue | ( | ) |
- Returns
- The event queue to use for creating a SubSurface.
Definition at line 80 of file subcompositor.cpp.
◆ isValid()
bool KWayland::Client::SubCompositor::isValid | ( | ) | const |
- Returns
true
if managing a wl_subcompositor.
Definition at line 65 of file subcompositor.cpp.
◆ release()
void KWayland::Client::SubCompositor::release | ( | ) |
Releases the wl_subcompositor interface.
After the interface has been released the SubCompositor instance is no longer valid and can be setup with another wl_subcompositor interface.
Definition at line 36 of file subcompositor.cpp.
◆ 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::createSubCompositor
- Since
- 5.5
◆ setEventQueue()
void KWayland::Client::SubCompositor::setEventQueue | ( | EventQueue * | queue | ) |
Sets the queue
to use for creating a SubSurface.
Definition at line 85 of file subcompositor.cpp.
◆ setup()
void KWayland::Client::SubCompositor::setup | ( | wl_subcompositor * | subcompositor | ) |
Setup this SubCompositor to manage the subcompositor
.
When using Registry::createSubCompositor there is no need to call this method.
Definition at line 46 of file subcompositor.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Feb 5 2023 03:56:52 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.