KWayland::Client::SubSurface

KWayland::Client::SubSurface Class Reference

#include <subsurface.h>

Inheritance diagram for KWayland::Client::SubSurface:

Public Types

enum  Mode { Synchronized, Desynchronized }
 

Public Member Functions

 SubSurface (QPointer< Surface > surface, QPointer< Surface > parentSurface, QObject *parent=nullptr)
 
void destroy ()
 
bool isValid () const
 
void lower ()
 
Mode mode () const
 
 operator wl_subsurface * ()
 
 operator wl_subsurface * () const
 
QPointer< SurfaceparentSurface () const
 
void placeAbove (QPointer< SubSurface > sibling)
 
void placeAbove (QPointer< Surface > referenceSurface)
 
void placeBelow (QPointer< SubSurface > sibling)
 
void placeBelow (QPointer< Surface > referenceSurface)
 
QPoint position () const
 
void raise ()
 
void release ()
 
void setMode (Mode mode)
 
void setPosition (const QPoint &pos)
 
void setup (wl_subsurface *subsurface)
 
QPointer< Surfacesurface () const
 
- 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 QPointer< SubSurfaceget (wl_subsurface *native)
 
- 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_subsurface interface.

This class is a convenient wrapper for the wl_subsurface interface. To create a SubSurface call SubCompositor::createSubSurface.

A SubSurface is bound to a Surface and has a parent Surface. A SubSurface can only be created for a Surface not already used in onther way, e.g. as a ShellSurface.

The SubSurface has a position in local coordinates to the parent Surface. Please note that changing the position is a double buffered state and is only applied once the parent surface is committed. The same applies for manipulating the stacking order of the SubSurface's siblings.

See also
SubCompositor
Surface

Definition at line 41 of file subsurface.h.

Member Enumeration Documentation

Operation Mode on how the Surface's commit should behave.

Definition at line 80 of file subsurface.h.

Member Function Documentation

void KWayland::Client::SubSurface::destroy ( )

Destroys the data held by this SubSurface.

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_subsurface interface once there is a new connection available.

See also
release

Definition at line 71 of file subsurface.cpp.

bool KWayland::Client::SubSurface::isValid ( ) const
Returns
true if managing a wl_subsurface.

Definition at line 81 of file subsurface.cpp.

void KWayland::Client::SubSurface::lower ( )

Lowers this SubSurface below all siblings.

This is the same as calling placeBelow with the parent surface as argument.

The change is only applied after the parent surface got committed.

See also
placeBelow

Definition at line 152 of file subsurface.cpp.

QPointer< Surface > KWayland::Client::SubSurface::parentSurface ( ) const
Returns
The parent Surface of this SubSurface.

Definition at line 91 of file subsurface.cpp.

void KWayland::Client::SubSurface::placeAbove ( QPointer< SubSurface sibling)

Places the SubSurface above the sibling.

The change is only applied after the parent surface got committed.

Parameters
siblingThe SubSurface on top of which this SubSurface should be placed

Definition at line 136 of file subsurface.cpp.

void KWayland::Client::SubSurface::placeAbove ( QPointer< Surface referenceSurface)

Places the SubSurface above the referenceSurface.

In case referenceSurface is the parent surface this SubSurface is raised to the top of the stacking order. Otherwise it is put directly above the referenceSurface in the stacking order.

The change is only applied after the parent surface got committed.

Parameters
referenceSurfaceEither a sibling or parent Surface

Definition at line 144 of file subsurface.cpp.

void KWayland::Client::SubSurface::placeBelow ( QPointer< SubSurface sibling)

Places the SubSurface below the sibling.

The change is only applied after the parent surface got committed.

Parameters
siblingThe SubSurface under which the SubSurface should be put

Definition at line 165 of file subsurface.cpp.

void KWayland::Client::SubSurface::placeBelow ( QPointer< Surface referenceSurface)

Places the SubSurface below the referenceSurface.

In case referenceSurface is the parent surface this SubSurface is lowered to the bottom of the stacking order. Otherwise it is put directly below the referenceSurface in the stacking order.

The change is only applied after the parent surface got committed.

Parameters
referenceSurfaceEither a sibling or parent Surface

Definition at line 157 of file subsurface.cpp.

void KWayland::Client::SubSurface::raise ( )

Raises this SubSurface above all siblings.

This is the same as calling placeAbove with the parent surface as argument.

The change is only applied after the parent surface got committed.

See also
placeAbove

Definition at line 131 of file subsurface.cpp.

void KWayland::Client::SubSurface::release ( )

Releases the wl_subsurface interface.

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

Definition at line 76 of file subsurface.cpp.

void KWayland::Client::SubSurface::setMode ( SubSurface::Mode  mode)

Sets the operation mode to mode.

Initially a SubSurface is in Synchronized Mode.

Definition at line 96 of file subsurface.cpp.

void KWayland::Client::SubSurface::setPosition ( const QPoint pos)

Sets the position in relative coordinates to the parent surface to pos.

The change is only applied after the parent Surface got committed.

Definition at line 117 of file subsurface.cpp.

void KWayland::Client::SubSurface::setup ( wl_subsurface *  subsurface)

Setup this SubSurface to manage the subsurface.

When using SubCompositor::createSubSurface there is no need to call this method.

Definition at line 66 of file subsurface.cpp.

QPointer< Surface > KWayland::Client::SubSurface::surface ( ) const
Returns
The Surface for which this SubSurface got created.

Definition at line 86 of file subsurface.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 Aug 5 2020 22:48:23 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.