KWayland::Server::PlasmaShellSurfaceInterface

KWayland::Server::PlasmaShellSurfaceInterface Class Reference

#include <plasmashell_interface.h>

Inheritance diagram for KWayland::Server::PlasmaShellSurfaceInterface:

Public Types

enum  PanelBehavior { PanelBehavior::AlwaysVisible, PanelBehavior::AutoHide, PanelBehavior::WindowsCanCover, PanelBehavior::WindowsGoBelow }
 
enum  Role {
  Role::Normal, Role::Desktop, Role::Panel, Role::OnScreenDisplay,
  Role::Notification, Role::ToolTip, Role::CriticalNotification
}
 

Signals

void panelAutoHideHideRequested ()
 
void panelAutoHideShowRequested ()
 
void panelBehaviorChanged ()
 
void panelTakesFocusChanged ()
 
void positionChanged ()
 
void roleChanged ()
 
void skipSwitcherChanged ()
 
void skipTaskbarChanged ()
 
- Signals inherited from KWayland::Server::Resource
void aboutToBeUnbound ()
 
void unbound ()
 

Public Member Functions

void hideAutoHidingPanel ()
 
bool isPositionSet () const
 
PanelBehavior panelBehavior () const
 
bool panelTakesFocus () const
 
QPoint position () const
 
Role role () const
 
PlasmaShellInterfaceshell () const
 
void showAutoHidingPanel ()
 
bool skipSwitcher () const
 
bool skipTaskbar () const
 
SurfaceInterfacesurface () const
 
- Public Member Functions inherited from KWayland::Server::Resource
ClientConnectionclient ()
 
void create (ClientConnection *client, quint32 version, quint32 id)
 
Globalglobal ()
 
quint32 id () const
 
wl_resource * parentResource () const
 
wl_resource * resource ()
 
- 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 PlasmaShellSurfaceInterfaceget (wl_resource *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 KWayland::Server::Resource
 Resource (Private *d, QObject *parent=nullptr)
 
- 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)
 
- Protected Attributes inherited from KWayland::Server::Resource
QScopedPointer< Private > d
 

Detailed Description

Resource for the org_kde_plasma_shell_surface interface.

PlasmaShellSurfaceInterface gets created by PlasmaShellInterface.

Since
5.4

Definition at line 65 of file plasmashell_interface.h.

Member Enumeration Documentation

Describes how a PlasmaShellSurfaceInterface with role Role::Panel should behave.

Enumerator
AlwaysVisible 

The panel should be always visible.

AutoHide 

The panel auto hides at a screen edge and returns on mouse press against edge.

WindowsCanCover 

Windows are allowed to go above the panel, it raises on mouse press against screen edge.

WindowsGoBelow 

Window are allowed to go below the panel.

Definition at line 109 of file plasmashell_interface.h.

Describes possible roles this PlasmaShellSurfaceInterface can have.

The role can be used by the server to e.g. change the stacking order accordingly.

Enumerator
Normal 

A normal surface.

Desktop 

The surface represents a desktop, normally stacked below all other surfaces.

Panel 

The surface represents a panel (dock), normally stacked above normal surfaces.

OnScreenDisplay 

The surface represents an on screen display, like a volume changed notification.

Notification 

The surface represents a notification.

Since
5.24
ToolTip 

The surface represents a tooltip.

Since
5.24
CriticalNotification 

The surface represents a critical notification, like battery is running out.

Since
5.58

Definition at line 93 of file plasmashell_interface.h.

Member Function Documentation

PlasmaShellSurfaceInterface * KWayland::Server::PlasmaShellSurfaceInterface::get ( wl_resource *  native)
static
Returns
The PlasmaShellSurfaceInterface for the native resource.
Since
5.5

Definition at line 398 of file plasmashell_interface.cpp.

void KWayland::Server::PlasmaShellSurfaceInterface::hideAutoHidingPanel ( )

Informs the PlasmaShellSurfaceInterface that the auto-hiding panel got hidden.

Once it is shown again the method showAutoHidingPanel should be used.

See also
showAutoHidingPanel
panelAutoHideHideRequested
panelAutoHideShowRequested
Since
5.28

Definition at line 374 of file plasmashell_interface.cpp.

bool KWayland::Server::PlasmaShellSurfaceInterface::isPositionSet ( ) const
Returns
Whether a global position has been requested.

Definition at line 350 of file plasmashell_interface.cpp.

void KWayland::Server::PlasmaShellSurfaceInterface::panelAutoHideHideRequested ( )
signal

A surface with Role Panel and PanelBehavior AutoHide requested to be hidden.

The compositor should inform the PlasmaShellSurfaceInterface about the actual change. Once the surface is hidden it should invoke hideAutoHidingPanel. If the compositor cannot hide the surface (e.g. because it doesn't border a screen edge) it should inform the surface through invoking showAutoHidingPanel. This method should also be invoked whenever the surface gets shown again due to triggering the screen edge.

See also
hideAutoHidingPanel
showAutoHidingPanel
panelAutoHideShowRequested
Since
5.28
void KWayland::Server::PlasmaShellSurfaceInterface::panelAutoHideShowRequested ( )
signal

A surface with Role Panel and PanelBehavior AutoHide requested to be shown.

The compositor should inform the PlasmaShellSurfaceInterface about the actual change. Once the surface is shown it should invoke showAutoHidingPanel.

See also
hideAutoHidingPanel
showAutoHidingPanel
panelAutoHideHideRequested
Since
5.28
PlasmaShellSurfaceInterface::PanelBehavior KWayland::Server::PlasmaShellSurfaceInterface::panelBehavior ( ) const
Returns
The PanelBehavior for a PlasmaShellSurfaceInterface with role Role::Panel
See also
role

Definition at line 356 of file plasmashell_interface.cpp.

void KWayland::Server::PlasmaShellSurfaceInterface::panelBehaviorChanged ( )
signal

A change of the panel behavior has been requested.

bool KWayland::Server::PlasmaShellSurfaceInterface::panelTakesFocus ( ) const

Whether a PlasmaShellSurfaceInterface wants to have focus.

By default some PlasmaShell roles do not get focus, but the PlasmaShellSurfaceInterface can request that it wants to have focus. The compositor can use this information to pass focus to the surface.

Since
5.28

Definition at line 392 of file plasmashell_interface.cpp.

QPoint KWayland::Server::PlasmaShellSurfaceInterface::position ( ) const
Returns
the requested position in global coordinates.

Definition at line 338 of file plasmashell_interface.cpp.

void KWayland::Server::PlasmaShellSurfaceInterface::positionChanged ( )
signal

A change of global position has been requested.

PlasmaShellSurfaceInterface::Role KWayland::Server::PlasmaShellSurfaceInterface::role ( ) const
Returns
The requested role, default value is Role::Normal.

Definition at line 344 of file plasmashell_interface.cpp.

void KWayland::Server::PlasmaShellSurfaceInterface::roleChanged ( )
signal

A change of the role has been requested.

PlasmaShellInterface * KWayland::Server::PlasmaShellSurfaceInterface::shell ( ) const
Returns
The PlasmaShellInterface which created this PlasmaShellSurfaceInterface.

Definition at line 179 of file plasmashell_interface.cpp.

void KWayland::Server::PlasmaShellSurfaceInterface::showAutoHidingPanel ( )

Informs the PlasmaShellSurfaceInterface that the auto-hiding panel got shown again.

See also
hideAutoHidingPanel
panelAutoHideHideRequested
panelAutoHideShowRequested
5.28

Definition at line 383 of file plasmashell_interface.cpp.

bool KWayland::Server::PlasmaShellSurfaceInterface::skipSwitcher ( ) const
Returns
true if this window doesn't want to be listed in a window switcher
Since
5.47

Definition at line 368 of file plasmashell_interface.cpp.

void KWayland::Server::PlasmaShellSurfaceInterface::skipSwitcherChanged ( )
signal

A change in the skip switcher property has been requested.

bool KWayland::Server::PlasmaShellSurfaceInterface::skipTaskbar ( ) const
Returns
true if this window doesn't want to be listed in the taskbar
Since
5.5

Definition at line 362 of file plasmashell_interface.cpp.

void KWayland::Server::PlasmaShellSurfaceInterface::skipTaskbarChanged ( )
signal

A change in the skip taskbar property has been requested.

SurfaceInterface * KWayland::Server::PlasmaShellSurfaceInterface::surface ( ) const
Returns
the SurfaceInterface this PlasmaShellSurfaceInterface got created for

Definition at line 174 of file plasmashell_interface.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 Nov 27 2020 22:51:55 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.