KWayland::Client::Dpms Class Reference

#include <dpms.h>

Inheritance diagram for KWayland::Client::Dpms:

Public Types
enum	Mode { On, Standby, Suspend, Off }

Signals
void	modeChanged ()
void	supportedChanged ()

Public Member Functions
void	destroy ()
bool	isSupported () const
bool	isValid () const
Mode	mode () const
	operator org_kde_kwin_dpms * ()
	operator org_kde_kwin_dpms * () const
QPointer< Output >	output () const
void	release ()
void	requestMode (Mode mode)
void	setup (org_kde_kwin_dpms *dpms)
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

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

Detailed Description

Power management for monitors.

Display Power Management Signaling allows power management for monitors. This class is a convenient wrapper for the org_kde_kwin_dpms interface. To create a Dpms call DpmsManager::getDpms.

See also

DpmsManager

Definition at line 130 of file dpms.h.

Member Function Documentation

destroy()

void KWayland::Client::Dpms::destroy

(

)

Destroys the data held by this Dpms.

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

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

connect(connection, &ConnectionThread::connectionDied, source, &Dpms::destroy);

See also

release

Definition at line 196 of file dpms.cpp.

isSupported()

bool KWayland::Client::Dpms::isSupported

(

)

const

Whether Dpms is supported for the Output.

Initially set to false.

Returns

whether Dpms is supported for the Output.

See also

supportedChanged

Definition at line 216 of file dpms.cpp.

isValid()

bool KWayland::Client::Dpms::isValid

(

)

const

Returns

true if managing a org_kde_kwin_dpms.

Definition at line 206 of file dpms.cpp.

mode()

Dpms::Mode KWayland::Client::Dpms::mode

(

)

const

The current Dpms mode.

Initially set to Mode::On.

Returns

the current Dpms mode of the Output

See also

modeChanged

Definition at line 221 of file dpms.cpp.

modeChanged

void KWayland::Client::Dpms::modeChanged ( )

signal

Emitted if the Dpms mode on the Output changes.

See also

mode

output()

QPointer< Output > KWayland::Client::Dpms::output

(

)

const

Returns

the Output for which this Dpms got created

Definition at line 248 of file dpms.cpp.

release()

void KWayland::Client::Dpms::release

(

)

Releases the org_kde_kwin_dpms interface.

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

Definition at line 201 of file dpms.cpp.

requestMode()

void KWayland::Client::Dpms::requestMode

(

Dpms::Mode

mode

)

Request to change the Output into Dpms mode.

The Wayland compositor is not obliged to honor the request. If the mode changes the client is notified and modeChanged gets emitted.

Parameters

mode	The requested Dpms mode.

Definition at line 226 of file dpms.cpp.

setup()

void KWayland::Client::Dpms::setup

(

org_kde_kwin_dpms *

dpms

)

Setup this Dpms to manage the dpms.

When using DpmsManager::createDpms there is no need to call this method.

Definition at line 211 of file dpms.cpp.

supportedChanged

void KWayland::Client::Dpms::supportedChanged ( )

signal

Emitted if the supported state on the Output changes.

See also

isSupported

---

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

• dpms.h
• dpms.cpp