KWayland::Client::PlasmaShell
#include <plasmashell.h>

Signals | |
void | interfaceAboutToBeDestroyed () |
void | interfaceAboutToBeReleased () |
void | removed () |
Public Member Functions | |
PlasmaShell (QObject *parent=nullptr) | |
PlasmaShellSurface * | createSurface (Surface *surface, QObject *parent=nullptr) |
PlasmaShellSurface * | createSurface (wl_surface *surface, QObject *parent=nullptr) |
void | destroy () |
EventQueue * | eventQueue () |
bool | isValid () const |
operator org_kde_plasma_shell * () | |
operator org_kde_plasma_shell * () const | |
void | release () |
void | setEventQueue (EventQueue *queue) |
void | setup (org_kde_plasma_shell *shell) |
![]() | |
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 org_kde_plasma_shell interface.
This class provides a convenient wrapper for the org_kde_plasma_shell interface. It's main purpose is to create a PlasmaShellSurface.
To use this class one needs to interact with the Registry. There are two possible ways to create the Shell interface:
This creates the PlasmaShell and sets it up directly. As an alternative this can also be done in a more low level way:
The PlasmaShell can be used as a drop-in replacement for any org_kde_plasma_shell pointer as it provides matching cast operators.
- See also
- Registry
- PlasmaShellSurface
Definition at line 51 of file plasmashell.h.
Member Function Documentation
◆ createSurface() [1/2]
PlasmaShellSurface * KWayland::Client::PlasmaShell::createSurface | ( | Surface * | surface, |
QObject * | parent = nullptr |
||
) |
Creates a PlasmaShellSurface for the given surface
and sets it up.
If a PlasmaShellSurface for the given surface
has already been created a pointer to the existing one is returned instead of creating a new surface.
- Parameters
-
surface The Surface to create the PlasmaShellSurface for parent The parent to use for the PlasmaShellSurface
- Returns
- created PlasmaShellSurface
Definition at line 117 of file plasmashell.cpp.
◆ createSurface() [2/2]
PlasmaShellSurface * KWayland::Client::PlasmaShell::createSurface | ( | wl_surface * | surface, |
QObject * | parent = nullptr |
||
) |
Creates a PlasmaShellSurface for the given surface
and sets it up.
If a PlasmaShellSurface for the given surface
has already been created a pointer to the existing one is returned instead of creating a new surface.
- Parameters
-
surface The native surface to create the PlasmaShellSurface for parent The parent to use for the PlasmaShellSurface
- Returns
- created PlasmaShellSurface
Definition at line 96 of file plasmashell.cpp.
◆ destroy()
void KWayland::Client::PlasmaShell::destroy | ( | ) |
Destroys the data held by this PlasmaShell.
This method is supposed to be used when the connection to the Wayland server goes away. Once the connection becomes invalid, 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 org_kde_plasma_shell interface once there is a new connection available.
This method is automatically invoked when the Registry which created this PlasmaShell gets destroyed.
Right before the data is destroyed, the signal interfaceAboutToBeDestroyed is emitted.
- See also
- release
- interfaceAboutToBeDestroyed
Definition at line 61 of file plasmashell.cpp.
◆ eventQueue()
EventQueue * KWayland::Client::PlasmaShell::eventQueue | ( | ) |
- Returns
- The event queue to use for creating a Surface.
Definition at line 91 of file plasmashell.cpp.
◆ interfaceAboutToBeDestroyed
|
signal |
This signal is emitted right before the data is destroyed.
◆ interfaceAboutToBeReleased
|
signal |
This signal is emitted right before the interface is released.
◆ isValid()
bool KWayland::Client::PlasmaShell::isValid | ( | ) | const |
- Returns
true
if managing a org_kde_plasma_shell.
Definition at line 122 of file plasmashell.cpp.
◆ release()
void KWayland::Client::PlasmaShell::release | ( | ) |
Releases the org_kde_plasma_shell interface.
After the interface has been released the PlasmaShell instance is no longer valid and can be setup with another org_kde_plasma_shell interface.
Right before the interface is released the signal interfaceAboutToBeReleased is emitted.
- See also
- interfaceAboutToBeReleased
Definition at line 70 of file plasmashell.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::createPlasmaShell
- Since
- 5.5
◆ setEventQueue()
void KWayland::Client::PlasmaShell::setEventQueue | ( | EventQueue * | queue | ) |
Sets the queue
to use for creating a Surface.
Definition at line 86 of file plasmashell.cpp.
◆ setup()
void KWayland::Client::PlasmaShell::setup | ( | org_kde_plasma_shell * | shell | ) |
Setup this Shell to manage the shell
.
When using Registry::createShell there is no need to call this method.
Definition at line 79 of file plasmashell.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.