KWayland::Client::PlasmaVirtualDesktopManagement

KWayland::Client::PlasmaVirtualDesktopManagement Class Reference

#include <plasmavirtualdesktop.h>

Inheritance diagram for KWayland::Client::PlasmaVirtualDesktopManagement:

Signals

void desktopCreated (const QString &id, quint32 position)
 
void desktopRemoved (const QString &id)
 
void done ()
 
void removed ()
 
void rowsChanged (quint32 rows)
 

Public Member Functions

 PlasmaVirtualDesktopManagement (QObject *parent=nullptr)
 
QList< PlasmaVirtualDesktop * > desktops () const
 
void destroy ()
 
EventQueueeventQueue ()
 
PlasmaVirtualDesktop * getVirtualDesktop (const QString &id)
 
bool isValid () const
 
 operator org_kde_plasma_virtual_desktop_management * ()
 
 operator org_kde_plasma_virtual_desktop_management * () const
 
void release ()
 
void requestCreateVirtualDesktop (const QString &name, quint32 position=std::numeric_limits< uint32_t >::max())
 
void requestRemoveVirtualDesktop (const QString &id)
 
quint32 rows () const
 
void setEventQueue (EventQueue *queue)
 
void setup (org_kde_plasma_virtual_desktop_management *plasmavirtualdesktopmanagement)
 
- 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_virtual_desktop_management interface.

This class provides a convenient wrapper for the org_kde_plasma_virtual_desktop_management interface.

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

PlasmaVirtualDesktopManagement *c = registry->createPlasmaVirtualDesktopManagement(name, version);

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

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

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

Since
5.52
See also
Registry

Definition at line 48 of file plasmavirtualdesktop.h.

Constructor & Destructor Documentation

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

Creates a new PlasmaVirtualDesktopManagement.

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

Definition at line 146 of file plasmavirtualdesktop.cpp.

Member Function Documentation

void KWayland::Client::PlasmaVirtualDesktopManagement::desktopCreated ( const QString id,
quint32  position 
)
signal

Emitted when a new desktop has been added.

void KWayland::Client::PlasmaVirtualDesktopManagement::desktopRemoved ( const QString id)
signal

Emitted when a desktop has been removed.

QList< PlasmaVirtualDesktop * > KWayland::Client::PlasmaVirtualDesktopManagement::desktops ( ) const
Returns
All the existent virtual desktops

Definition at line 251 of file plasmavirtualdesktop.cpp.

void KWayland::Client::PlasmaVirtualDesktopManagement::destroy ( )

Destroys the data held by this PlasmaVirtualDesktopManagement.

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

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

See also
release

Definition at line 179 of file plasmavirtualdesktop.cpp.

void KWayland::Client::PlasmaVirtualDesktopManagement::done ( )
signal

This event is sent after all other properties has been sent after binding to the desktop manager object and after any other property changes done after that.

This allows changes to the org_kde_plasma_virtual_desktop_management properties to be seen as atomic, even if they happen via multiple events.

EventQueue * KWayland::Client::PlasmaVirtualDesktopManagement::eventQueue ( )
Returns
The event queue to use for creating objects with this PlasmaVirtualDesktopManagement. The object is owned by the manager and the caller should not delete it.

Definition at line 202 of file plasmavirtualdesktop.cpp.

PlasmaVirtualDesktop * KWayland::Client::PlasmaVirtualDesktopManagement::getVirtualDesktop ( const QString id)
Returns
the PlasmaVirtualDesktop representing the desktop id. The PlasmaVirtualDesktop instance is guaranteed to be unique for each id.

Definition at line 207 of file plasmavirtualdesktop.cpp.

bool KWayland::Client::PlasmaVirtualDesktopManagement::isValid ( ) const
Returns
true if managing a org_kde_plasma_virtual_desktop_management.

Definition at line 192 of file plasmavirtualdesktop.cpp.

void KWayland::Client::PlasmaVirtualDesktopManagement::release ( )

Releases the org_kde_plasma_virtual_desktop_management interface.

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

Definition at line 174 of file plasmavirtualdesktop.cpp.

void KWayland::Client::PlasmaVirtualDesktopManagement::requestCreateVirtualDesktop ( const QString name,
quint32  position = std::numeric_limits<uint32_t>::max() 
)

Ask the server to create a new virtual desktop, and position it at a specified position.

If the position is zero or less, it will be positioned at the beginning, if the cosition is the count or more, it will be positioned at the end.

Parameters
nameThe name we want for the desktop
positionThe position for the desktop to be created

Definition at line 244 of file plasmavirtualdesktop.cpp.

void KWayland::Client::PlasmaVirtualDesktopManagement::requestRemoveVirtualDesktop ( const QString id)

Requests for the desktop identified by id to be removed.

The server may or may not acconsent to the request.

Definition at line 237 of file plasmavirtualdesktop.cpp.

quint32 KWayland::Client::PlasmaVirtualDesktopManagement::rows ( ) const
Returns
How many rows the virtual desktops should be laid out into
Since
5.55

Definition at line 256 of file plasmavirtualdesktop.cpp.

void KWayland::Client::PlasmaVirtualDesktopManagement::rowsChanged ( quint32  rows)
signal

Emitted when the number of rows of virtual desktops has been changed by the server.

Since
5.55
void KWayland::Client::PlasmaVirtualDesktopManagement::setEventQueue ( EventQueue queue)

Sets the queue to use for creating objects with this PlasmaVirtualDesktopManagement.

Definition at line 197 of file plasmavirtualdesktop.cpp.

void KWayland::Client::PlasmaVirtualDesktopManagement::setup ( org_kde_plasma_virtual_desktop_management *  plasmavirtualdesktopmanagement)

Setup this PlasmaVirtualDesktopManagement to manage the plasmavirtualdesktopmanagement.

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

Definition at line 169 of file plasmavirtualdesktop.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 Fri Sep 18 2020 22:49:46 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.