KWayland::Server::XdgShellSurfaceInterface

Search for usage in LXR

KWayland::Server::XdgShellSurfaceInterface Class Reference

#include <xdgshell_interface.h>

Inheritance diagram for KWayland::Server::XdgShellSurfaceInterface:

Public Types

enum  State { State::Maximized = 1 << 0, State::Fullscreen = 1 << 1, State::Resizing = 1 << 2, State::Activated = 1 << 3 }
 
typedef QFlags< StateStates
 

Signals

void configureAcknowledged (quint32 serial)
 
void fullscreenChanged (bool fullscreen, KWayland::Server::OutputInterface *output)
 
void maximizedChanged (bool maximized)
 
void maxSizeChanged (const QSize &size)
 
void minimizeRequested ()
 
void minSizeChanged (const QSize &size)
 
void moveRequested (KWayland::Server::SeatInterface *seat, quint32 serial)
 
void resizeRequested (KWayland::Server::SeatInterface *seat, quint32 serial, Qt::Edges edges)
 
void titleChanged (const QString &)
 
void transientForChanged ()
 
void windowClassChanged (const QByteArray &)
 
void windowGeometryChanged (const QRect &windowGeometry)
 
void windowMenuRequested (KWayland::Server::SeatInterface *seat, quint32 serial, const QPoint &surfacePos)
 
- Signals inherited from KWayland::Server::Resource
void aboutToBeUnbound ()
 
void unbound ()
 

Public Member Functions

void close ()
 
quint32 configure (States states, const QSize &size=QSize(0, 0))
 
XdgShellInterfaceVersion interfaceVersion () const
 
bool isConfigurePending () const
 
bool isTransient () const
 
QSize maximumSize () const
 
QSize minimumSize () const
 
SurfaceInterfacesurface () const
 
QString title () const
 
QPointer< XdgShellSurfaceInterfacetransientFor () const
 
QByteArray windowClass () const
 
QRect windowGeometry () 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 QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, 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 (const QObject *object)
 
qobject_cast (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
 

Protected Member Functions

 XdgShellSurfaceInterface (Private *p)
 
- 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)
 

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 *context, Functor functor, 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)
 
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction 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 Attributes inherited from KWayland::Server::Resource
QScopedPointer< Private > d
 

Detailed Description

Since
5.25

Definition at line 180 of file xdgshell_interface.h.

Member Enumeration Documentation

◆ State

States the Surface can be in.

Enumerator
Maximized 

The Surface is maximized.

Fullscreen 

The Surface is fullscreen.

Resizing 

The Surface is currently being resized by the Compositor.

Activated 

The Surface is considered active.

Does not imply keyboard focus.

Definition at line 194 of file xdgshell_interface.h.

Member Function Documentation

◆ close()

void KWayland::Server::XdgShellSurfaceInterface::close ( )

Request the client to close the window.

Definition at line 142 of file xdgshell_interface.cpp.

◆ configure()

quint32 KWayland::Server::XdgShellSurfaceInterface::configure ( States  states,
const QSize size = QSize(0, 0) 
)

Sends a configure event to the Surface.

This tells the Surface the current states it is in and the size it should have. If size has width and height at 0, the Surface can choose the size.

The Surface acknowledges the configure event with configureAcknowledged.

Parameters
statesThe states the surface is in
sizeThe requested size
Returns
The serial of the configure event
See also
configureAcknowledged
isConfigurePending

Definition at line 100 of file xdgshell_interface.cpp.

◆ configureAcknowledged

void KWayland::Server::XdgShellSurfaceInterface::configureAcknowledged ( quint32  serial)
signal

A configure event with serial got acknowledged.

See also
configure

◆ fullscreenChanged

void KWayland::Server::XdgShellSurfaceInterface::fullscreenChanged ( bool  fullscreen,
KWayland::Server::OutputInterface output 
)
signal

The surface requested a change of fullscreen state.

Parameters
fullscreenWhether the window wants to be fullscreen
outputAn optional output hint on which the window wants to be fullscreen

◆ interfaceVersion()

XdgShellInterfaceVersion KWayland::Server::XdgShellSurfaceInterface::interfaceVersion ( ) const
Returns
The interface version used by this XdgShellSurfaceInterface

Definition at line 94 of file xdgshell_interface.cpp.

◆ isConfigurePending()

bool KWayland::Server::XdgShellSurfaceInterface::isConfigurePending ( ) const
Returns
true if there is a not yet acknowledged configure event.
See also
configure
configureAcknowledged

Definition at line 106 of file xdgshell_interface.cpp.

◆ isTransient()

bool KWayland::Server::XdgShellSurfaceInterface::isTransient ( ) const
Returns
Whether this Surface is a transient for another Surface, that is it has a parent.
See also
transientFor

Definition at line 130 of file xdgshell_interface.cpp.

◆ maximizedChanged

void KWayland::Server::XdgShellSurfaceInterface::maximizedChanged ( bool  maximized)
signal

The surface requested a change of maximized state.

Parameters
maximizedWhether the window wants to be maximized

◆ maximumSize()

QSize KWayland::Server::XdgShellSurfaceInterface::maximumSize ( ) const
Returns
The maximum size for the window specified by the client.
Since
5.65

Definition at line 160 of file xdgshell_interface.cpp.

◆ maxSizeChanged

void KWayland::Server::XdgShellSurfaceInterface::maxSizeChanged ( const QSize size)
signal

Emitted whenever the maximum size hint changes.

Since
5.39

◆ minimizeRequested

void KWayland::Server::XdgShellSurfaceInterface::minimizeRequested ( )
signal

The surface requested to be minimized.

◆ minimumSize()

QSize KWayland::Server::XdgShellSurfaceInterface::minimumSize ( ) const
Returns
The minimum size for the window specified by the client.
Since
5.65

Definition at line 154 of file xdgshell_interface.cpp.

◆ minSizeChanged

void KWayland::Server::XdgShellSurfaceInterface::minSizeChanged ( const QSize size)
signal

Emitted whenever the minimum size hint changes.

Since
5.39

◆ moveRequested

void KWayland::Server::XdgShellSurfaceInterface::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

◆ resizeRequested

void KWayland::Server::XdgShellSurfaceInterface::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

◆ surface()

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

Definition at line 112 of file xdgshell_interface.cpp.

◆ title()

QString KWayland::Server::XdgShellSurfaceInterface::title ( ) const
Returns
The title of this surface.
See also
titleChanged

Definition at line 118 of file xdgshell_interface.cpp.

◆ titleChanged

void KWayland::Server::XdgShellSurfaceInterface::titleChanged ( const QString )
signal

Emitted whenever the title changes.

See also
title

◆ transientFor()

QPointer< XdgShellSurfaceInterface > KWayland::Server::XdgShellSurfaceInterface::transientFor ( ) const
Returns
the parent surface if the surface is a transient for another surface
See also
isTransient

Definition at line 136 of file xdgshell_interface.cpp.

◆ transientForChanged

void KWayland::Server::XdgShellSurfaceInterface::transientForChanged ( )
signal

Emitted whenever the parent surface changes.

See also
isTransient
transientFor

◆ windowClassChanged

void KWayland::Server::XdgShellSurfaceInterface::windowClassChanged ( const QByteArray )
signal

Emitted whenever the window class changes.

See also
windowClass

◆ windowGeometry()

QRect KWayland::Server::XdgShellSurfaceInterface::windowGeometry ( ) const

windowGeometry The geometry of the window within the buffer

If invalid, the geometry of the buffer should be used instead

Since
5.59

Definition at line 148 of file xdgshell_interface.cpp.

◆ windowGeometryChanged

void KWayland::Server::XdgShellSurfaceInterface::windowGeometryChanged ( const QRect windowGeometry)
signal

windowGeometryChanged

Parameters
windowGeometrythe newly changed windowGeometry
Since
5.59

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Jan 29 2023 03:54:10 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.