KWayland::Server::ShellSurfaceInterface

Properties | Signals | Public Member Functions | List of all members
KWayland::Server::ShellSurfaceInterface Class Reference

#include <shell_interface.h>

Inheritance diagram for KWayland::Server::ShellSurfaceInterface:
Inheritance graph
[legend]

Properties

bool acceptsKeyboardFocus
 
bool fullscreen
 
bool maximized
 
bool popup
 
QString title
 
bool toplevel
 
bool transient
 
QPoint transientOffset
 
QByteArray windowClass
 
- Properties inherited from QObject
 objectName
 

Signals

void acceptsKeyboardFocusChanged ()
 
void fullscreenChanged (bool)
 
void maximizedChanged (bool)
 
void moveRequested (KWayland::Server::SeatInterface *seat, quint32 serial)
 
void pingTimeout ()
 
void pongReceived ()
 
void popupChanged (bool)
 
void resizeRequested (KWayland::Server::SeatInterface *seat, quint32 serial, Qt::Edges edges)
 
void titleChanged (const QString &)
 
void toplevelChanged (bool)
 
void transientChanged (bool)
 
void transientForChanged ()
 
void transientOffsetChanged (const QPoint &)
 
void windowClassChanged (const QByteArray &)
 
- Signals inherited from KWayland::Server::Resource
void aboutToBeUnbound ()
 
void unbound ()
 

Public Member Functions

bool acceptsKeyboardFocus () const
 
bool isFullscreen () const
 
bool isMaximized () const
 
bool isPinged () const
 
bool isPopup () const
 
bool isToplevel () const
 
bool isTransient () const
 
void ping ()
 
void popupDone ()
 
void requestSize (const QSize &size)
 
void setPingTimeout (uint msec)
 
ShellInterface * shell () const
 
SurfaceInterface * surface () const
 
QString title () const
 
QPointer< SurfaceInterface > transientFor () const
 
QPoint transientOffset () const
 
QByteArray windowClass () const
 
- Public Member Functions inherited from KWayland::Server::Resource
ClientConnection * client ()
 
void create (ClientConnection *client, quint32 version, quint32 id)
 
Global * global ()
 
quint32 id () const
 
wl_resource * parentResource () const
 
wl_resource * resource ()
 
- Public Member Functions inherited from QObject
 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 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 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 &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
T qobject_cast (QObject *object)
 
T 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)
 
QThread * thread () const const
 

Additional Inherited Members

- 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 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
 
QObject * sender () 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 a wl_shell_surface.

The ShellSurfaceInterface represents a "normal window". It gets created for a SurfaceInterface, thus has visible content. Through the ShellSurfaceInterface the client can specify further meta-information about how the SurfaceInterface should be represented.

See also
SurfaceInterface
ShellInterface

Definition at line 67 of file shell_interface.h.

Property Documentation

bool KWayland::Server::ShellSurfaceInterface::acceptsKeyboardFocus
read

Whether the ShellSurfaceInterface can accept keyboard focus.

By default ShellSurfaceInterface accepts keyboard focus, only transient surfaces might not want keyboard focus.

Since
5.5

Definition at line 117 of file shell_interface.h.

bool KWayland::Server::ShellSurfaceInterface::fullscreen
read

Whether the window is fullscreen.

Definition at line 81 of file shell_interface.h.

bool KWayland::Server::ShellSurfaceInterface::maximized
read

Whether the window is maximized.

Definition at line 89 of file shell_interface.h.

bool KWayland::Server::ShellSurfaceInterface::popup
read

Whether the ShellSurfaceInterface is a popup for another SurfaceInterface.

Popup implies transient.

Since
5.5

Definition at line 96 of file shell_interface.h.

QString KWayland::Server::ShellSurfaceInterface::title
read

The window title.

Definition at line 73 of file shell_interface.h.

bool KWayland::Server::ShellSurfaceInterface::toplevel
read

Whether the window is a normal toplevel window (not a child).

Definition at line 85 of file shell_interface.h.

bool KWayland::Server::ShellSurfaceInterface::transient
read

Whether the ShellSurfaceInterface is a transient for another SurfaceInterface.

Popup implies transient.

Since
5.5

Definition at line 103 of file shell_interface.h.

QPoint KWayland::Server::ShellSurfaceInterface::transientOffset
read

Offset of the upper left corner in the parent SurfaceInterface's coordinate system.

Since
5.5

Definition at line 108 of file shell_interface.h.

QByteArray KWayland::Server::ShellSurfaceInterface::windowClass
read

The window class, representing the desktop file name.

Definition at line 77 of file shell_interface.h.

Member Function Documentation

bool KWayland::Server::ShellSurfaceInterface::acceptsKeyboardFocus ( ) const

Whether the ShellSurfaceInterface can accept keyboard focus.

This is only relevant for transient and popup windows. By default all ShellSurfaces accept keyboard focus.

Returns
Whether the ShellSurfaceInterface can accept keyboard focus.
See also
isTransient()
acceptsKeyboardFocusChanged
Since
5.5
void KWayland::Server::ShellSurfaceInterface::acceptsKeyboardFocusChanged ( )
signal
Since
5.5
bool KWayland::Server::ShellSurfaceInterface::isPinged ( ) const
Returns
whether the ShellSurfaceInterface got pinged, but no pong received.
See also
ping

Definition at line 232 of file shell_interface.cpp.

bool KWayland::Server::ShellSurfaceInterface::isPopup ( ) const
Returns
true if the ShellSurfaceInterface is a popup.
See also
isTransient
transientOffset
transientFor
Since
5.5

Definition at line 423 of file shell_interface.cpp.

bool KWayland::Server::ShellSurfaceInterface::isTransient ( ) const
Returns
true if the ShellSurfaceInterface is a transient or popup for another SurfaceInterface.
See also
isPopup
transientOffset
transientFor
Since
5.5

Definition at line 429 of file shell_interface.cpp.

void KWayland::Server::ShellSurfaceInterface::moveRequested ( KWayland::Server::SeatInterface *  seat,
quint32  serial 
)
signal

The surface requested a window move.

Parameters
seatThe SeatInterface on which the surface requested the move
serialThe serial of the implicit mouse grab which triggered the move
Since
5.5
void KWayland::Server::ShellSurfaceInterface::ping ( )

Pings the client.

The client is required to send a pong. If that is not received in the times tamp set through setPingTimeout the signal pingTimeout will be emitted. If a pong is received the signal pongReceived will be emitted.

See also
setPingTimeout
pingTimeout
pongReceived
isPinged

Definition at line 206 of file shell_interface.cpp.

void KWayland::Server::ShellSurfaceInterface::pingTimeout ( )
signal

Emitted when the ping timed out.

See also
ping
pingTimeout
isPinged
void KWayland::Server::ShellSurfaceInterface::pongReceived ( )
signal

Emitted when the server received a pong for this ShellSurfaceInterface.

void KWayland::Server::ShellSurfaceInterface::popupChanged ( bool  )
signal
Since
5.5
void KWayland::Server::ShellSurfaceInterface::popupDone ( )

Sends a popup done event to the shell surface.

This is only relevant for popup windows. It indicates that the popup grab got canceled. This happens when e.g. the user clicks outside of any surface of the same client as this ShellSurfaceInterface. It is the task of the compositor to send the popupDone event appropriately.

See also
isPopup
Since
5.33

Definition at line 447 of file shell_interface.cpp.

void KWayland::Server::ShellSurfaceInterface::requestSize ( const QSize &  size)

Requests that the ShellSurfaceInterface resizes the SurfaceInterface to size.

Definition at line 238 of file shell_interface.cpp.

void KWayland::Server::ShellSurfaceInterface::resizeRequested ( KWayland::Server::SeatInterface *  seat,
quint32  serial,
Qt::Edges  edges 
)
signal

The surface requested a window resize.

Parameters
seatThe SeatInterface on which the surface requested the resize
serialThe serial of the implicit mouse grab which triggered the resize
edgesA hint which edges are involved in the resize
Since
5.5
void KWayland::Server::ShellSurfaceInterface::setPingTimeout ( uint  msec)

Sets the ping time out for ping requests to msec.

Parameters
msecThe time out in msec
See also
ping
isPinged

Definition at line 226 of file shell_interface.cpp.

ShellInterface * KWayland::Server::ShellSurfaceInterface::shell ( ) const
Returns
The ShellInterface which created this ShellSurfaceInterface.

Definition at line 393 of file shell_interface.cpp.

SurfaceInterface * KWayland::Server::ShellSurfaceInterface::surface ( ) const
Returns
The SurfaceInterface this ShellSurfaceInterface got created for.

Definition at line 388 of file shell_interface.cpp.

void KWayland::Server::ShellSurfaceInterface::titleChanged ( const QString &  )
signal

Emitted whenever the title changes.

void KWayland::Server::ShellSurfaceInterface::transientChanged ( bool  )
signal
Since
5.5
QPointer< SurfaceInterface > KWayland::Server::ShellSurfaceInterface::transientFor ( ) const

The SurfaceInterface for which this ShellSurfaceInterface is a transient.

This is only relevant if the ShellSurfaceInterface is either a transient or a popup.

The transientOffset is in the local coordinate system of the SurfaceInterface returned by this method.

Returns
The SurfaceInterface for which this Surface is a transient
See also
isTransient
isPopup
transientOffset
Since
5.5

Definition at line 455 of file shell_interface.cpp.

void KWayland::Server::ShellSurfaceInterface::transientForChanged ( )
signal
Since
5.5
QPoint KWayland::Server::ShellSurfaceInterface::transientOffset ( ) const

In case the ShellSurfaceInterface is a transient this is the offset of the ShellSurfaceInterface in the coordinate system of the SurfaceInterface this surface is a transient for.

Returns
offset in parent coordinate system.
See also
isTransient
transientFor
Since
5.5
void KWayland::Server::ShellSurfaceInterface::transientOffsetChanged ( const QPoint &  )
signal
Since
5.5
void KWayland::Server::ShellSurfaceInterface::windowClassChanged ( const QByteArray &  )
signal

Emitted whenever the window class changes.

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 Wed May 27 2020 23:04:42 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.