KWayland::Server::Global Class Reference

#include <global.h>

Inheritance diagram for KWayland::Server::Global:

Signals
void	aboutToDestroyGlobal ()

Public Member Functions
void	create ()
void	destroy ()
Display *	display ()
bool	isValid () const
	operator wl_global * ()
	operator wl_global * () 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
	Global (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
QScopedPointer< Private >	d

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

Base class for all Globals.

Any class representing a Global should be derived from this base class. This class provides common functionality for all globals. A global is an object listed as an interface on the registry on client side.

Normally a Global gets factored by the Display. For each Global-derived class there is a dedicated factory method. After creating an instance through the factory method it is not yet announced on the registry. One needs to call ::create on it. This allows to setup the Global before it gets announced, ensuring that the client's state is correct from the start.

As an example shown for OutputInterface:

Display *display; // The existing display
auto o = display->createOutput();
o->setManufacturer(QStringLiteral("The KDE Community"));
// setup further data on the OutputInterface
o->create(); // announces OutputInterface

See also

Display

Definition at line 46 of file global.h.

Member Function Documentation

aboutToDestroyGlobal

void KWayland::Server::Global::aboutToDestroyGlobal ( )

signal

This signal is emitted when the client is in the process of removing the wl_global.

At the time the signal is emitted the global is still valid and allows to perform cleanup tasks.

create()

void KWayland::Server::Global::create

(

)

Creates the global by creating a native wl_global and by that announcing it to the clients.

Definition at line 48 of file global.cpp.

destroy()

void KWayland::Server::Global::destroy

(

)

Destroys the low level wl_global.

Afterwards the Global is no longer shown to clients.

Definition at line 53 of file global.cpp.

display()

Display * KWayland::Server::Global::display

(

)

Returns

the Display the Global got created on.

Definition at line 78 of file global.cpp.

isValid()

bool KWayland::Server::Global::isValid

(

)

const

Returns

whether the Global got created

Definition at line 63 of file global.cpp.

operator wl_global *() [1/2]

KWayland::Server::Global::operator wl_global *

(

)

Cast operator to the native wl_global this Global represents.

Definition at line 68 of file global.cpp.

operator wl_global *() [2/2]

KWayland::Server::Global::operator wl_global *

(

)

const

Cast operator to the native wl_global this Global represents.

---

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

• global.h
• global.cpp