KWayland::Server::PlasmaWindowInterface

KWayland::Server::PlasmaWindowInterface Class Reference

#include <plasmawindowmanagement_interface.h>

Inheritance diagram for KWayland::Server::PlasmaWindowInterface:

Signals

void activeRequested (bool set)
 
void closeableRequested (bool set)
 
void closeRequested ()
 
void demandsAttentionRequested (bool set)
 
void enterNewPlasmaVirtualDesktopRequested ()
 
void enterPlasmaVirtualDesktopRequested (const QString &desktop)
 
void fullscreenableRequested (bool set)
 
void fullscreenRequested (bool set)
 
void keepAboveRequested (bool set)
 
void keepBelowRequested (bool set)
 
void leavePlasmaVirtualDesktopRequested (const QString &desktop)
 
void maximizeableRequested (bool set)
 
void maximizedRequested (bool set)
 
void minimizeableRequested (bool set)
 
QRect minimizedGeometriesChanged ()
 
void minimizedRequested (bool set)
 
void movableRequested (bool set)
 
void moveRequested ()
 
void resizableRequested (bool set)
 
void resizeRequested ()
 
void shadeableRequested (bool set)
 
void shadedRequested (bool set)
 
void skipSwitcherRequested (bool set)
 
void skipTaskbarRequested (bool set)
 
void virtualDesktopChangeableRequested (bool set)
 
void virtualDesktopRequested (quint32 desktop)
 

Public Member Functions

void addPlasmaVirtualDesktop (const QString &id)
 
quint32 internalId () const
 
QHash< SurfaceInterface *, QRectminimizedGeometries () const
 
QStringList plasmaVirtualDesktops () const
 
void removePlasmaVirtualDesktop (const QString &id)
 
void setActive (bool set)
 
void setAppId (const QString &appId)
 
void setApplicationMenuPaths (const QString &serviceName, const QString &objectPath)
 
void setCloseable (bool set)
 
void setDemandsAttention (bool set)
 
void setFullscreen (bool set)
 
void setFullscreenable (bool set)
 
void setGeometry (const QRect &geometry)
 
void setIcon (const QIcon &icon)
 
void setKeepAbove (bool set)
 
void setKeepBelow (bool set)
 
void setMaximizeable (bool set)
 
void setMaximized (bool set)
 
void setMinimizeable (bool set)
 
void setMinimized (bool set)
 
void setMovable (bool set)
 
void setOnAllDesktops (bool set)
 
void setParentWindow (PlasmaWindowInterface *parentWindow)
 
void setPid (quint32 pid)
 
void setResizable (bool set)
 
void setShadeable (bool set)
 
void setShaded (bool set)
 
void setSkipSwitcher (bool skip)
 
void setSkipTaskbar (bool skip)
 
void setThemedIconName (const QString &iconName)
 
void setTitle (const QString &title)
 
void setVirtualDesktop (quint32 desktop)
 
void setVirtualDesktopChangeable (bool set)
 
void unmap ()
 
- 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

Todo:
Add documentation

Definition at line 96 of file plasmawindowmanagement_interface.h.

Member Function Documentation

void KWayland::Server::PlasmaWindowInterface::addPlasmaVirtualDesktop ( const QString id)

Adds a new desktop to this window: a window can be on an arbitrary subset of virtual desktops.

If it's on none it will be considered on all desktops.

Since
5.48

Definition at line 913 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::enterNewPlasmaVirtualDesktopRequested ( )
signal

Emitted when the client wishes this window to enter in a new virtual desktop to be created for it.

The server will decide whether to consent this request

Since
5.52
void KWayland::Server::PlasmaWindowInterface::enterPlasmaVirtualDesktopRequested ( const QString desktop)
signal

Emitted when the client wishes this window to enter in a new virtual desktop.

The server will decide whether to consent this request

Since
5.52
quint32 KWayland::Server::PlasmaWindowInterface::internalId ( ) const

Return the window internal id.

Since
5.70

Definition at line 999 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::leavePlasmaVirtualDesktopRequested ( const QString desktop)
signal

Emitted when the client wishes to remove this window from a virtual desktop.

The server will decide whether to consent this request

Since
5.52
QHash< SurfaceInterface *, QRect > KWayland::Server::PlasmaWindowInterface::minimizedGeometries ( ) const
Returns
Geometries of the taskbar entries, indicized by the surface of the panels
Since
5.5

Definition at line 796 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::movableRequested ( bool  set)
signal
Since
5.22
void KWayland::Server::PlasmaWindowInterface::moveRequested ( )
signal
Since
5.22
QStringList KWayland::Server::PlasmaWindowInterface::plasmaVirtualDesktops ( ) const

The ids of all the desktops currently associated with this window.

When a desktop is deleted it will be automatically removed from this list

Since
5.48

Definition at line 954 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::removePlasmaVirtualDesktop ( const QString id)

Removes a visrtual desktop from a window.

Since
5.48

Definition at line 937 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::resizableRequested ( bool  set)
signal
Since
5.22
void KWayland::Server::PlasmaWindowInterface::resizeRequested ( )
signal
Since
5.22
void KWayland::Server::PlasmaWindowInterface::setApplicationMenuPaths ( const QString serviceName,
const QString objectPath 
)

Set the application menu D-BUS service name and object path for the window.

Since
5.69

Definition at line 994 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setGeometry ( const QRect geometry)

Sets the window geometry of this PlasmaWindow.

Parameters
geometryThe geometry in absolute coordinates
Since
5.25

Definition at line 989 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setIcon ( const QIcon icon)

Set the icon of the PlasmaWindowInterface.

In case the icon has a themed name, only the name is sent to the client. Otherwise the client is only informed that there is an icon and the client can request the icon in an asynchronous way by passing a file descriptor into which the icon will be serialized.

Parameters
iconThe new icon
Since
5.28

Definition at line 908 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setMovable ( bool  set)
Since
5.22

Definition at line 969 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setParentWindow ( PlasmaWindowInterface parentWindow)

Sets this PlasmaWindowInterface as a transient window to parentWindow.

If parentWindow is nullptr, the PlasmaWindowInterface is a toplevel window and does not have a parent window.

Since
5.24

Definition at line 984 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setResizable ( bool  set)
Since
5.22

Definition at line 974 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setShadeable ( bool  set)
Since
5.22

Definition at line 959 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setShaded ( bool  set)
Since
5.22

Definition at line 964 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setThemedIconName ( const QString iconName)
Deprecated:
since 5.28 use setIcon

Definition at line 903 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setVirtualDesktop ( quint32  desktop)
Deprecated:
Since 5.52, use addPlasmaVirtualDesktop and removePlasmaVirtualDesktop

Definition at line 786 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::setVirtualDesktopChangeable ( bool  set)

FIXME: still relevant with new desktops?

Since
5.22

Definition at line 979 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::shadeableRequested ( bool  set)
signal
Since
5.22
void KWayland::Server::PlasmaWindowInterface::shadedRequested ( bool  set)
signal
Since
5.22
void KWayland::Server::PlasmaWindowInterface::unmap ( )

This method removes the Window and the Client is supposed to release the resource bound for this Window.

Once all resources are released the Window gets deleted.

Prefer using PlasmaWindowManagementInterface::unmapWindow.

See also
PlasmaWindowManagementInterface::unmapWindow

Definition at line 791 of file plasmawindowmanagement_interface.cpp.

void KWayland::Server::PlasmaWindowInterface::virtualDesktopChangeableRequested ( bool  set)
signal

FIXME: still relevant with new virtual desktops?

Since
5.22
void KWayland::Server::PlasmaWindowInterface::virtualDesktopRequested ( quint32  desktop)
signal
Deprecated:
Since 5.52, use enterPlasmaVirtualDesktopRequested and leavePlasmaVirtualDesktopRequested instead

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 Jun 5 2020 22:51:31 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.