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 }

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
SurfaceInterface *	surface () const
QString	title () const
QPointer< XdgShellSurfaceInterface >	transientFor () const
QByteArray	windowClass () const
QRect	windowGeometry () 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
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () 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
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () 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 *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)
Protected Attributes inherited from KWayland::Server::Resource
QScopedPointer< Private >	d

Detailed Description

Since

5.25

Definition at line 197 of file xdgshell_interface.h.

Member Enumeration Documentation

enum KWayland::Server::XdgShellSurfaceInterface::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 211 of file xdgshell_interface.h.

Member Function Documentation

void KWayland::Server::XdgShellSurfaceInterface::close

(

)

Request the client to close the window.

Definition at line 151 of file xdgshell_interface.cpp.

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

states	The states the surface is in
size	The requested size

Returns

The serial of the configure event

See also

configureAcknowledged

isConfigurePending

Definition at line 109 of file xdgshell_interface.cpp.

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

signal

A configure event with serial got acknowledged.

See also

configure

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

signal

The surface requested a change of fullscreen state.

Parameters

fullscreen	Whether the window wants to be fullscreen
output	An optional output hint on which the window wants to be fullscreen

XdgShellInterfaceVersion KWayland::Server::XdgShellSurfaceInterface::interfaceVersion

(

)

const

Returns

The interface version used by this XdgShellSurfaceInterface

Definition at line 103 of file xdgshell_interface.cpp.

bool KWayland::Server::XdgShellSurfaceInterface::isConfigurePending

(

)

const

Returns

true if there is a not yet acknowledged configure event.

See also

configure

configureAcknowledged

Definition at line 115 of file xdgshell_interface.cpp.

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 139 of file xdgshell_interface.cpp.

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

signal

The surface requested a change of maximized state.

Parameters

maximized

Whether the window wants to be maximized

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

signal

Emitted whenever the maximum size hint changes.

Since

5.39

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

signal

The surface requested to be minimized.

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

signal

Emitted whenever the minimum size hint changes.

Since

5.39

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

signal

The surface requested a window move.

Parameters

seat	The SeatInterface on which the surface requested the move
serial	The serial of the implicit mouse grab which triggered the move

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

signal

The surface requested a window resize.

Parameters

seat	The SeatInterface on which the surface requested the resize
serial	The serial of the implicit mouse grab which triggered the resize
edges	A hint which edges are involved in the resize

SurfaceInterface * KWayland::Server::XdgShellSurfaceInterface::surface

(

)

const

Returns

The SurfaceInterface this XdgSurfaceV5Interface got created for.

Definition at line 121 of file xdgshell_interface.cpp.

QString KWayland::Server::XdgShellSurfaceInterface::title

(

)

const

Returns

The title of this surface.

See also

titleChanged

Definition at line 127 of file xdgshell_interface.cpp.

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

signal

Emitted whenever the title changes.

See also

title

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 145 of file xdgshell_interface.cpp.

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

signal

Emitted whenever the parent surface changes.

See also

isTransient

transientFor

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

signal

Emitted whenever the window class changes.

See also

windowClass

QRect KWayland::Server::XdgShellSurfaceInterface::windowGeometry

(

)

const

windowGeometry The geometry of the window within the buffer

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

Since

5.59

Definition at line 157 of file xdgshell_interface.cpp.

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

signal

windowGeometryChanged

Parameters

windowGeometry

the newly changed windowGeometry

Since

5.59

---

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

• xdgshell_interface.h
• xdgshell_interface.cpp