KWayland::Client::PlasmaShell

KWayland::Client::PlasmaShell Class Reference

#include <plasmashell.h>

Inheritance diagram for KWayland::Client::PlasmaShell:

Signals

void interfaceAboutToBeDestroyed ()
 
void interfaceAboutToBeReleased ()
 
void removed ()
 

Public Member Functions

 PlasmaShell (QObject *parent=nullptr)
 
PlasmaShellSurfacecreateSurface (wl_surface *surface, QObject *parent=nullptr)
 
PlasmaShellSurfacecreateSurface (Surface *surface, QObject *parent=nullptr)
 
void destroy ()
 
EventQueueeventQueue ()
 
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)
 
- 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

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

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:

PlasmaShell *s = registry->createPlasmaShell(name, version);

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

PlasmaShell *s = new PlasmaShell;
s->setup(registry->bindPlasmaShell(name, version));

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

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
surfaceThe native surface to create the PlasmaShellSurface for
parentThe parent to use for the PlasmaShellSurface
Returns
created PlasmaShellSurface

Definition at line 97 of file plasmashell.cpp.

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
surfaceThe Surface to create the PlasmaShellSurface for
parentThe parent to use for the PlasmaShellSurface
Returns
created PlasmaShellSurface

Definition at line 118 of file plasmashell.cpp.

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 62 of file plasmashell.cpp.

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

Definition at line 92 of file plasmashell.cpp.

void KWayland::Client::PlasmaShell::interfaceAboutToBeDestroyed ( )
signal

This signal is emitted right before the data is destroyed.

void KWayland::Client::PlasmaShell::interfaceAboutToBeReleased ( )
signal

This signal is emitted right before the interface is released.

bool KWayland::Client::PlasmaShell::isValid ( ) const
Returns
true if managing a org_kde_plasma_shell.

Definition at line 123 of file plasmashell.cpp.

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 71 of file plasmashell.cpp.

void KWayland::Client::PlasmaShell::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
void KWayland::Client::PlasmaShell::setEventQueue ( EventQueue queue)

Sets the queue to use for creating a Surface.

Definition at line 87 of file plasmashell.cpp.

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 80 of file plasmashell.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 Tue May 26 2020 23:07:41 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.