KWayland::Client::IdleInhibitManager Class Reference

#include <idleinhibit.h>

Inheritance diagram for KWayland::Client::IdleInhibitManager:

Signals
void	removed ()

Public Member Functions
	IdleInhibitManager (QObject *parent=nullptr)
IdleInhibitor *	createInhibitor (Surface *surface, QObject *parent=nullptr)
void	destroy ()
EventQueue *	eventQueue ()
bool	isValid () const
	operator zwp_idle_inhibit_manager_v1 * ()
	operator zwp_idle_inhibit_manager_v1 * () const
void	release ()
void	setEventQueue (EventQueue *queue)
void	setup (zwp_idle_inhibit_manager_v1 *idleinhibitmanager)
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 zwp_idle_inhibit_manager_v1 interface.

This class provides a convenient wrapper for the zwp_idle_inhibit_manager_v1 interface.

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

IdleInhibitManager *c = registry->createIdleInhibitManager(name, version);

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

IdleInhibitManager *c = new IdleInhibitManager;
c->setup(registry->bindIdleInhibitManager(name, version));

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

See also

Registry

Since

5.41

Definition at line 63 of file idleinhibit.h.

Constructor & Destructor Documentation

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

explicit

Creates a new IdleInhibitManager.

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

Definition at line 43 of file idleinhibit.cpp.

Member Function Documentation

IdleInhibitor * KWayland::Client::IdleInhibitManager::createInhibitor	(	Surface *	surface,
		QObject *	parent = nullptr
	)

Creates an IdleInhibitor for the given surface.

While the IdleInhibitor exists the surface is marked to inhibit idle.

Parameters

surface	The Surface which should have idle inhibited
parent	The parent object for the IdleInhibitor

Returns

The created IdleInhibitor

Definition at line 99 of file idleinhibit.cpp.

void KWayland::Client::IdleInhibitManager::destroy

(

)

Destroys the data held by this IdleInhibitManager.

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

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

connect(connection, &ConnectionThread::connectionDied, idleinhibitmanager, &IdleInhibitManager::destroy);

See also

release

Definition at line 71 of file idleinhibit.cpp.

EventQueue * KWayland::Client::IdleInhibitManager::eventQueue

(

)

Returns

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

Definition at line 94 of file idleinhibit.cpp.

bool KWayland::Client::IdleInhibitManager::isValid

(

)

const

Returns

true if managing a zwp_idle_inhibit_manager_v1.

Definition at line 84 of file idleinhibit.cpp.

void KWayland::Client::IdleInhibitManager::release

(

)

Releases the zwp_idle_inhibit_manager_v1 interface.

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

Definition at line 66 of file idleinhibit.cpp.

void KWayland::Client::IdleInhibitManager::removed ( )

signal

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

This signal gets only emitted if the IdleInhibitManager got created by Registry::createIdleInhibitManager

void KWayland::Client::IdleInhibitManager::setEventQueue

(

EventQueue *

queue

)

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

Definition at line 89 of file idleinhibit.cpp.

void KWayland::Client::IdleInhibitManager::setup

(

zwp_idle_inhibit_manager_v1 *

idleinhibitmanager

)

Setup this IdleInhibitManager to manage the idleinhibitmanager.

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

Definition at line 61 of file idleinhibit.cpp.

---

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

• idleinhibit.h
• idleinhibit.cpp