KWayland - KWayland::Client::Dpms Class Reference

View on LXR

KWayland
Client
Dpms

#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

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

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 145 of file dpms.h.

Member Function Documentation

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 217 of file dpms.cpp.

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 237 of file dpms.cpp.

bool KWayland::Client::Dpms::isValid ( ) const

Returns: true if managing a org_kde_kwin_dpms.

Definition at line 227 of file dpms.cpp.

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 242 of file dpms.cpp.

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

signal

Emitted if the Dpms mode on the Output changes.

See also: mode

QPointer< Output > KWayland::Client::Dpms::output ( ) const

Returns: the Output for which this Dpms got created

Definition at line 269 of file dpms.cpp.

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 222 of file dpms.cpp.

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 247 of file dpms.cpp.

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 232 of file dpms.cpp.

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:

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

KWayland::Client::Dpms

Public Types

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation