KWayland::Client::ServerSideDecoration Class Reference

#include <server_decoration.h>

Inheritance diagram for KWayland::Client::ServerSideDecoration:

Public Types
enum	Mode { Mode::None, Mode::Client, Mode::Server }

Signals
void	modeChanged ()

Public Member Functions
Mode	defaultMode () const
void	destroy ()
bool	isValid () const
Mode	mode () const
	operator org_kde_kwin_server_decoration * ()
	operator org_kde_kwin_server_decoration * () const
void	release ()
void	requestMode (Mode mode)
void	setup (org_kde_kwin_server_decoration *serversidedecoration)
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

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

Detailed Description

Describing how a Surface should be decorated.

Use ServerSideDecorationManager::create to create a ServerSideDecoration.

See also

ServerSideDecorationManager

Since

5.6

Definition at line 148 of file server_decoration.h.

Member Enumeration Documentation

enum KWayland::Client::ServerSideDecoration::Mode

strong

Decoration mode used for the Surface.

Enumerator
None	Undecorated: neither client, nor server provide decoration. Example: popups.
Client	The decoration is part of the surface.
Server	The surface gets embedded into a decoration frame provided by the Server.

Definition at line 189 of file server_decoration.h.

Member Function Documentation

ServerSideDecoration::Mode KWayland::Client::ServerSideDecoration::defaultMode

(

)

const

Returns

The default decoration mode the server uses

See also

mode

Definition at line 288 of file server_decoration.cpp.

void KWayland::Client::ServerSideDecoration::destroy

(

)

Destroys the data held by this ServerSideDecoration.

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

This method is automatically invoked when the Registry which created this ServerDecoration gets destroyed.

See also

release

Definition at line 245 of file server_decoration.cpp.

bool KWayland::Client::ServerSideDecoration::isValid

(

)

const

Returns

true if managing a org_kde_kwin_server_decoration.

Definition at line 258 of file server_decoration.cpp.

ServerSideDecoration::Mode KWayland::Client::ServerSideDecoration::mode

(

)

const

Returns

The current decoration mode for the Surface.

The mode represents the mode pushed from the Server.

See also

requestMode

modeChanged

Definition at line 283 of file server_decoration.cpp.

void KWayland::Client::ServerSideDecoration::modeChanged ( )

signal

Emitted whenever the Server changes the decoration mode for the Surface.

See also

requestMode

mode

void KWayland::Client::ServerSideDecoration::release

(

)

Releases the org_kde_kwin_server_decoration interface.

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

Definition at line 240 of file server_decoration.cpp.

void KWayland::Client::ServerSideDecoration::requestMode

(

Mode

mode

)

Request the decoration mode for the Surface.

The server will acknowledge the change which will trigger the modeChanged signal.

See also

mode

modeChanged

Definition at line 263 of file server_decoration.cpp.

void KWayland::Client::ServerSideDecoration::setup

(

org_kde_kwin_server_decoration *

serversidedecoration

)

Setup this ServerSideDecoration to manage the serversidedecoration.

When using ServerSideDecorationManager::createServerSideDecoration there is no need to call this method.

Definition at line 235 of file server_decoration.cpp.

---

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

• server_decoration.h
• server_decoration.cpp