KWayland::Client::AppMenuManager Class Reference

#include <appmenu.h>

Inheritance diagram for KWayland::Client::AppMenuManager:

Signals
void	removed ()

Public Member Functions
	AppMenuManager (QObject *parent=nullptr)
AppMenu *	create (Surface *surface, QObject *parent=nullptr)
void	destroy ()
EventQueue *	eventQueue ()
bool	isValid () const
	operator org_kde_kwin_appmenu_manager * ()
	operator org_kde_kwin_appmenu_manager * () const
void	release ()
void	setEventQueue (EventQueue *queue)
void	setup (org_kde_kwin_appmenu_manager *appmenumanager)
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

Wrapper for the org_kde_kwin_appmenu_manager interface.

This class provides a convenient wrapper for the org_kde_kwin_appmenu_manager interface.

To use this class one needs to interact with the Registry. There are two possible ways to create the AppMenuManager interface:

AppMenuManager *c = registry->createAppMenuManager(name, version);

This creates the AppMenuManager and sets it up directly. As an alternative this can also be done in a more low level way:

AppMenuManager *c = new AppMenuManager;
c->setup(registry->bindAppMenuManager(name, version));

The AppMenuManager can be used as a drop-in replacement for any org_kde_kwin_appmenu_manager pointer as it provides matching cast operators.

See also

Registry

Since

5.42

Definition at line 63 of file appmenu.h.

Constructor & Destructor Documentation

KWayland::Client::AppMenuManager::AppMenuManager ( QObject *  parent = nullptr )

explicit

Creates a new AppMenuManager.

Note: after constructing the AppMenuManager it is not yet valid and one needs to call setup. In order to get a ready to use AppMenuManager prefer using Registry::createAppMenuManager.

Definition at line 43 of file appmenu.cpp.

Member Function Documentation

void KWayland::Client::AppMenuManager::destroy

(

)

Destroys the data held by this AppMenuManager.

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

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

connect(connection, &ConnectionThread::connectionDied, appmenumanager, &AppMenuManager::destroy);

See also

release

Definition at line 71 of file appmenu.cpp.

EventQueue * KWayland::Client::AppMenuManager::eventQueue

(

)

Returns

The event queue to use for creating objects with this AppMenuManager.

Definition at line 94 of file appmenu.cpp.

bool KWayland::Client::AppMenuManager::isValid

(

)

const

Returns

true if managing a org_kde_kwin_appmenu_manager.

Definition at line 84 of file appmenu.cpp.

void KWayland::Client::AppMenuManager::release

(

)

Releases the org_kde_kwin_appmenu_manager interface.

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

Definition at line 66 of file appmenu.cpp.

void KWayland::Client::AppMenuManager::removed ( )

signal

The corresponding global for this interface on the Registry got removed.

This signal gets only emitted if the AppMenuManager got created by Registry::createAppMenuManager

void KWayland::Client::AppMenuManager::setEventQueue

(

EventQueue *

queue

)

Sets the queue to use for creating objects with this AppMenuManager.

Definition at line 89 of file appmenu.cpp.

void KWayland::Client::AppMenuManager::setup

(

org_kde_kwin_appmenu_manager *

appmenumanager

)

Setup this AppMenuManager to manage the appmenumanager.

When using Registry::createAppMenuManager there is no need to call this method.

Definition at line 61 of file appmenu.cpp.

---

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

• appmenu.h
• appmenu.cpp