PowermanagementEngine Class Reference

#include <powermanagementengine.h>

Inheritance diagram for PowermanagementEngine:

Public Member Functions
	PowermanagementEngine (QObject *parent)
Plasma5Support::Service *	serviceForSource (const QString &source) override
QStringList	sources () const override
Public Member Functions inherited from Plasma5Support::DataEngine
	DataEngine (const KPluginMetaData &plugin, QObject *parent=nullptr)
	DataEngine (QObject *parent=nullptr)
Q_INVOKABLE void	connectAllSources (QObject *visualization, uint pollingInterval=0, Plasma5Support::Types::IntervalAlignment intervalAlignment=Types::NoAlignment) const
Q_INVOKABLE void	connectSource (const QString &source, QObject *visualization, uint pollingInterval=0, Plasma5Support::Types::IntervalAlignment intervalAlignment=Types::NoAlignment) const
Q_INVOKABLE DataContainer *	containerForSource (const QString &source)
Q_INVOKABLE void	disconnectSource (const QString &source, QObject *visualization) const
bool	isEmpty () const
bool	isValid () const
KPluginMetaData	metadata () const
QAbstractItemModel *	modelForSource (const QString &source)
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 Member Functions
void	init ()
bool	sourceRequestEvent (const QString &name) override
bool	updateSourceEvent (const QString &source) override
Protected Member Functions inherited from Plasma5Support::DataEngine
void	addSource (DataContainer *source)
QHash< QString, DataContainer * >	containerDict () const
int	minimumPollingInterval () const
void	removeAllData (const QString &source)
void	removeAllSources ()
void	removeData (const QString &source, const QString &key)
void	setData (const QString &source, const QString &key, const QVariant &value)
void	setData (const QString &source, const QVariant &value)
void	setData (const QString &source, const QVariantMap &data)
void	setMinimumPollingInterval (int minimumMs)
void	setModel (const QString &source, QAbstractItemModel *model)
void	setPollingInterval (uint frequency)
void	setStorageEnabled (const QString &source, bool store)
void	setValid (bool valid)
void	timerEvent (QTimerEvent *event) override
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

Additional Inherited Members
Public Types inherited from Plasma5Support::DataEngine
typedef QMap< QString, QVariant >	Data
typedef QMapIterator< QString, QVariant >	DataIterator
typedef QHash< QString, DataEngine * >	Dict
typedef QHash< QString, DataContainer * >	SourceDict
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Signals inherited from Plasma5Support::DataEngine
void	sourceAdded (const QString &source)
void	sourceRemoved (const QString &source)
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)
Protected Slots inherited from Plasma5Support::DataEngine
void	forceImmediateUpdateOfAllVisualizations ()
void	removeSource (const QString &source)
void	updateAllSources ()

Detailed Description

This class provides runtime information about the battery and AC status for use in power management Plasma applets.

Definition at line 27 of file powermanagementengine.h.

Constructor & Destructor Documentation

PowermanagementEngine()

PowermanagementEngine::PowermanagementEngine

(

QObject *

parent

)

Definition at line 63 of file powermanagementengine.cpp.

~PowermanagementEngine()

PowermanagementEngine::~PowermanagementEngine ( )

override

Definition at line 74 of file powermanagementengine.cpp.

Member Function Documentation

init()

void PowermanagementEngine::init ( )

protected

Definition at line 78 of file powermanagementengine.cpp.

serviceForSource()

Plasma5Support::Service * PowermanagementEngine::serviceForSource ( const QString & source )

overridevirtual

Parameters

source

the source to target the Service at

Returns

a Service that has the source as a destination. The service is parented to the DataEngine, but should be deleted by the caller when finished with it

Reimplemented from Plasma5Support::DataEngine.

Definition at line 386 of file powermanagementengine.cpp.

sourceRequestEvent()

bool PowermanagementEngine::sourceRequestEvent ( const QString & source )

overrideprotectedvirtual

When a source that does not currently exist is requested by the consumer, this method is called to give the DataEngine the opportunity to create one.

The name of the data source (e.g. the source parameter passed into setData) must be the same as the name passed to sourceRequestEvent otherwise the requesting visualization may not receive notice of a data update.

If the source can not be populated with data immediately (e.g. due to an asynchronous data acquisition method such as an HTTP request) the source must still be created, even if it is empty. This can be accomplished in these cases with the follow line:

 setData(name, DataEngine::Data());

Parameters

source

the name of the source that has been requested

Returns

true if a DataContainer was set up, false otherwise

Reimplemented from Plasma5Support::DataEngine.

Definition at line 209 of file powermanagementengine.cpp.

sources()

QStringList PowermanagementEngine::sources ( ) const

overridevirtual

Returns

a list of all the data sources available via this DataEngine Whether these sources are currently available (which is what the default implementation provides) or not is up to the DataEngine to decide.

Reimplemented from Plasma5Support::DataEngine.

Definition at line 204 of file powermanagementengine.cpp.

updateSourceEvent()

bool PowermanagementEngine::updateSourceEvent ( const QString & source )

overrideprotectedvirtual

Called by internal updating mechanisms to trigger the engine to refresh the data contained in a given source.

Reimplement this method when using facilities such as setPollingInterval.

See also

setPollingInterval

Parameters

source

the name of the source that should be updated

Returns

true if the data was changed, or false if there was no change or if the change will occur later

Reimplemented from Plasma5Support::DataEngine.

Definition at line 377 of file powermanagementengine.cpp.

---

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

• powermanagementengine.h
• powermanagementengine.cpp