Solid::Inhibition Class Reference

#include <inhibition.h>

Inheritance diagram for Solid::Inhibition:

Public Types
enum	State { Stopped = 0 , Started = 1 }

Properties
State	state
Properties inherited from QObject
	objectName

Signals
void	stateChanged (Inhibition::State newState)

Public Slots
void	start ()
void	stop ()

Public Member Functions
	Inhibition (AbstractInhibition *backend, QObject *parent=nullptr)
State	state () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
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 () const const
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 QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
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_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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	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	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Attributes
InhibitionPrivate *const	d_ptr

Additional Inherited Members
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)
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

Holds an inhibition.

This object is returned by Power::InhibitionJob::inhibition and it holds a reference to the inhibition that has been performed.

When this object is deleted the inhibition will be released

Definition at line 26 of file inhibition.h.

Member Enumeration Documentation

State

enum Solid::Inhibition::State

Definition at line 31 of file inhibition.h.

Property Documentation

state

State Solid::Inhibition::state

read

Definition at line 29 of file inhibition.h.

Constructor & Destructor Documentation

Inhibition()

Inhibition::Inhibition ( AbstractInhibition * backend, QObject * parent = nullptr )

explicit

This is meant to be instantiated by backends only.

AbstractInhibition is not part of Solid public API so this constructor is meant to be used only by backends.

Definition at line 18 of file inhibition.cpp.

~Inhibition()

Inhibition::~Inhibition ( )

virtual

Definition at line 26 of file inhibition.cpp.

Member Function Documentation

start

void Inhibition::start ( )

slot

Starts the inhibition.

In case state() is Stopped, it will resume the inhibition. This happens asynchronously so connect to stateChanged() signal to know when start() has changed the state.

Definition at line 32 of file inhibition.cpp.

state()

Inhibition::State Inhibition::state

(

)

const

Returns the current state of the object.

The initial value is Started since that is how InhibitionJob will return it. The state can be modified by calling stop() and start(). Also stateChanged() signal is available.

Definition at line 42 of file inhibition.cpp.

stop

void Inhibition::stop ( )

slot

Stops the inhibition.

In case the state() is Started, it will stop the inhibition. This happens asynchronously so connect to stateChanged() signal to know when stop() has changed the state.

Definition at line 37 of file inhibition.cpp.

Member Data Documentation

d_ptr

InhibitionPrivate* const Solid::Inhibition::d_ptr

protected

Definition at line 75 of file inhibition.h.

---

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

• inhibition.h
• inhibition.cpp