KWayland::Client::XdgShellSurface

KWayland
Client
XdgShellSurface

#include <xdgshell.h>

Inheritance diagram for KWayland::Client::XdgShellSurface:

Public Types
enum	State { State::Maximized = 1 << 0, State::Fullscreen = 1 << 1, State::Resizing = 1 << 2, State::Activated = 1 << 3 }

typedef QFlags< State >	States

Signals
void	closeRequested ()

void	configureRequested (const QSize &size, KWayland::Client::XdgShellSurface::States states, quint32 serial)

void	sizeChanged (const QSize &)

Public Member Functions
void	ackConfigure (quint32 serial)

void	destroy ()

EventQueue *	eventQueue ()

bool	isValid () const

	operator xdg_surface * ()

	operator xdg_surface * () const

	operator xdg_toplevel * ()

	operator xdg_toplevel * () const

	operator zxdg_surface_v6 * ()

	operator zxdg_surface_v6 * () const

	operator zxdg_toplevel_v6 * ()

	operator zxdg_toplevel_v6 * () const

void	release ()

void	requestMinimize ()

void	requestMove (Seat *seat, quint32 serial)

void	requestResize (Seat *seat, quint32 serial, Qt::Edges edges)

void	requestShowWindowMenu (Seat *seat, quint32 serial, const QPoint &pos)

void	setAppId (const QByteArray &appId)

void	setEventQueue (EventQueue *queue)

void	setFullscreen (bool set, Output *output=nullptr)

void	setMaximized (bool set)

void	setMaxSize (const QSize &size)

void	setMinSize (const QSize &size)

void	setSize (const QSize &size)

void	setTitle (const QString &title)

void	setTransientFor (XdgShellSurface *parent)

void	setup (xdg_surface xdgsurface, xdg_toplevel toplevel)

void	setup (xdg_surface *xdgsurfacev5)

void	setup (zxdg_surface_v6 xdgsurfacev6, zxdg_toplevel_v6 toplevel)

void	setWindowGeometry (const QRect &windowGeometry)

QSize	size () const

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 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 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 (const QObject *object)

T	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)

QThread *	thread () const const

Protected Member Functions
	XdgShellSurface (Private p, 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)

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

Detailed Description

Since: 5.25

Definition at line 274 of file xdgshell.h.

Member Enumeration Documentation

◆ State

enum KWayland::Client::XdgShellSurface::State

strong

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 282 of file xdgshell.h.

Member Function Documentation

◆ ackConfigure()

void KWayland::Client::XdgShellSurface::ackConfigure ( quint32 serial )

When a configure event is received, if a client commits the Surface in response to the configure event, then the client must make an ackConfigure request sometime before the commit request, passing along the serial of the configure event.

See also: configureRequested

Definition at line 249 of file xdgshell.cpp.

◆ closeRequested

void KWayland::Client::XdgShellSurface::closeRequested ( )

signal

The compositor requested to close this window.

◆ configureRequested

void KWayland::Client::XdgShellSurface::configureRequested	(	const QSize &	size,
		KWayland::Client::XdgShellSurface::States	states,
		quint32	serial
	)

signal

The compositor sent a configure with the new size and the states.

Before the next commit of the surface the serial needs to be passed to ackConfigure.

◆ destroy()

void KWayland::Client::XdgShellSurface::destroy ( )

Destroys the data held by this XdgShellSurface.

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

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

connect(connection, &ConnectionThread::connectionDied, xdgsurfacev5, &XdgShellSurface::destroy);

See also: release

Definition at line 159 of file xdgshell.cpp.

◆ eventQueue()

EventQueue * KWayland::Client::XdgShellSurface::eventQueue ( )

Returns: The event queue to use for bound proxies.

Definition at line 169 of file xdgshell.cpp.

◆ isValid()

bool KWayland::Client::XdgShellSurface::isValid ( ) const

Returns: true if managing a xdg_surface.

Definition at line 214 of file xdgshell.cpp.

◆ release()

void KWayland::Client::XdgShellSurface::release ( )

Releases the xdg_surface interface.

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

Definition at line 154 of file xdgshell.cpp.

◆ requestMinimize()

void KWayland::Client::XdgShellSurface::requestMinimize ( )

Request to the compositor to minimize this XdgShellSurface.

Definition at line 287 of file xdgshell.cpp.

◆ requestMove()

void KWayland::Client::XdgShellSurface::requestMove	(	Seat *	seat,
		quint32	serial
	)

Requests a move on the given seat after the pointer button press with the given serial.

Parameters

seat	The seat on which to move the window
serial	The serial of the pointer button press which should trigger the move

Definition at line 239 of file xdgshell.cpp.

◆ requestResize()

void KWayland::Client::XdgShellSurface::requestResize	(	Seat *	seat,
		quint32	serial,
		Qt::Edges	edges
	)

Requests a resize on the given seat after the pointer button press with the given serial.

Parameters

seat	The seat on which to resize the window
serial	The serial of the pointer button press which should trigger the resize
edges	A hint for the compositor to set e.g. an appropriate cursor image

Definition at line 244 of file xdgshell.cpp.

◆ requestShowWindowMenu()

void KWayland::Client::XdgShellSurface::requestShowWindowMenu	(	Seat *	seat,
		quint32	serial,
		const QPoint &	pos
	)

Requests to show the window menu at pos in surface coordinates.

Definition at line 234 of file xdgshell.cpp.

◆ setAppId()

void KWayland::Client::XdgShellSurface::setAppId ( const QByteArray & appId )

Set an application identifier for the surface.

Definition at line 229 of file xdgshell.cpp.

◆ setEventQueue()

void KWayland::Client::XdgShellSurface::setEventQueue ( EventQueue * queue )

Sets the queue to use for bound proxies.

Definition at line 164 of file xdgshell.cpp.

◆ setFullscreen()

void KWayland::Client::XdgShellSurface::setFullscreen	(	bool	set,
		Output *	output = `nullptr`
	)

Request to set this XdgShellSurface as fullscreen on output.

If set is true the Surface should be set to fullscreen, otherwise restore from fullscreen state.

Parameters

set	Whether the Surface should be fullscreen or not
output	Optional output as hint to the compositor where the Surface should be put

Definition at line 263 of file xdgshell.cpp.

◆ setMaximized()

void KWayland::Client::XdgShellSurface::setMaximized ( bool set )

Request to set this XdgShellSurface to be maximized if set is true.

If set is false it requests to unset the maximized state - if set.

Parameters

set	Whether the XdgShellSurface should be maximized

Definition at line 254 of file xdgshell.cpp.

◆ setMaxSize()

void KWayland::Client::XdgShellSurface::setMaxSize ( const QSize & size )

Set this surface to have a given maximum size.

Since: 5.39

Definition at line 272 of file xdgshell.cpp.

◆ setMinSize()

void KWayland::Client::XdgShellSurface::setMinSize ( const QSize & size )

Set this surface to have a given minimum size.

Since: 5.39

Definition at line 277 of file xdgshell.cpp.

◆ setSize()

void KWayland::Client::XdgShellSurface::setSize ( const QSize & size )

Sets the size for the XdgShellSurface to size.

This is mostly an internal information. The actual size of the XdgShellSurface is determined by the size of the Buffer attached to the XdgShellSurface's Surface.

Parameters

size	The new size to be used for the XdgShellSurface

See also: size; sizeChanged

Definition at line 292 of file xdgshell.cpp.

◆ setTitle()

void KWayland::Client::XdgShellSurface::setTitle ( const QString & title )

Sets the window title of this XdgShellSurface to title.

Definition at line 224 of file xdgshell.cpp.

◆ setTransientFor()

void KWayland::Client::XdgShellSurface::setTransientFor ( XdgShellSurface * parent )

Set this XdgShellSurface as transient for parent.

Definition at line 219 of file xdgshell.cpp.

◆ setup() [1/3]

void KWayland::Client::XdgShellSurface::setup	(	xdg_surface *	xdgsurface,
		xdg_toplevel *	toplevel
	)

Setup this XdgShellSurface to manage the toplevel on the relevant xdgsurface When using XdgShell::createXdgShellSurface there is no need to call this method.

Definition at line 149 of file xdgshell.cpp.

◆ setup() [2/3]

void KWayland::Client::XdgShellSurface::setup ( xdg_surface * xdgsurfacev5 )

Setup this XdgShellSurface to manage the xdgsurfacev5.

When using XdgShell::createXdgShellSurface there is no need to call this method.

Definition at line 139 of file xdgshell.cpp.

◆ setup() [3/3]

void KWayland::Client::XdgShellSurface::setup	(	zxdg_surface_v6 *	xdgsurfacev6,
		zxdg_toplevel_v6 *	toplevel
	)

Setup this XdgShellSurface to manage the toplevel on the relevant xdgsurfacev6 When using XdgShell::createXdgShellSurface there is no need to call this method.

Definition at line 144 of file xdgshell.cpp.

◆ setWindowGeometry()

void KWayland::Client::XdgShellSurface::setWindowGeometry ( const QRect & windowGeometry )

Sets the position of the window contents within the buffer.

Since: 5.59

Definition at line 282 of file xdgshell.cpp.

◆ size()

QSize KWayland::Client::XdgShellSurface::size ( ) const

The currently configured size.

See also: sizeChanged; setSize

Definition at line 301 of file xdgshell.cpp.

◆ sizeChanged

void KWayland::Client::XdgShellSurface::sizeChanged ( const QSize & )

signal

Emitted whenever the size of the XdgShellSurface changes by e.g.

receiving a configure request.

See also: configureRequested; size; setSize

The documentation for this class was generated from the following files:

QObject::connect

QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)

KWayland::Client::XdgShellSurface::destroy

void destroy()

Destroys the data held by this XdgShellSurface.

Definition: xdgshell.cpp:159

KWayland::Client::ConnectionThread::connectionDied

void connectionDied()

Emitted if the Wayland server connection dies.

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWayland

KWayland::Client::XdgShellSurface

Public Types

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ State

Member Function Documentation

◆ ackConfigure()

◆ closeRequested

◆ configureRequested

◆ destroy()

◆ eventQueue()

◆ isValid()

◆ release()

◆ requestMinimize()

◆ requestMove()

◆ requestResize()

◆ requestShowWindowMenu()

◆ setAppId()

◆ setEventQueue()

◆ setFullscreen()

◆ setMaximized()

◆ setMaxSize()

◆ setMinSize()

◆ setSize()

◆ setTitle()

◆ setTransientFor()

◆ setup() [1/3]

◆ setup() [2/3]

◆ setup() [3/3]

◆ setWindowGeometry()

◆ size()

◆ sizeChanged