Solid::Ifaces::DeviceManager

Solid::Ifaces::DeviceManager Class Referenceabstract

#include <devicemanager.h>

Inheritance diagram for Solid::Ifaces::DeviceManager:

Signals

void deviceAdded (const QString &udi)
 
void deviceRemoved (const QString &udi)
 

Public Member Functions

 DeviceManager (QObject *parent=nullptr)
 
virtual ~DeviceManager ()
 
virtual QStringList allDevices ()=0
 
virtual QObjectcreateDevice (const QString &udi)=0
 
virtual QStringList devicesFromQuery (const QString &parentUdi, Solid::DeviceInterface::Type type=Solid::DeviceInterface::Unknown)=0
 
virtual QSet< Solid::DeviceInterface::TypesupportedInterfaces () const =0
 
virtual QString udiPrefix () const =0
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (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
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
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)
 
qobject_cast (QObject *object)
 
qobject_cast (const 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)
 
QThreadthread () 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 *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)
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

This class specifies the interface a backend will have to implement in order to be used in the system.

A device manager allows to query the underlying platform to discover the available devices. It has also the responsibility to notify when a device appears or disappears.

Definition at line 28 of file devicemanager.h.

Constructor & Destructor Documentation

Solid::Ifaces::DeviceManager::DeviceManager ( QObject parent = nullptr)

Constructs a DeviceManager.

Definition at line 9 of file ifaces/devicemanager.cpp.

Solid::Ifaces::DeviceManager::~DeviceManager ( )
virtual

Destructs a DeviceManager object.

Definition at line 15 of file ifaces/devicemanager.cpp.

Member Function Documentation

virtual QStringList Solid::Ifaces::DeviceManager::allDevices ( )
pure virtual

Retrieves the Universal Device Identifier (UDI) of all the devices available in the system.

This identifier is unique for each device in the system.

Returns
the UDIs of all the devices in the system

Implemented in Solid::Backends::Fake::FakeManager.

virtual QObject* Solid::Ifaces::DeviceManager::createDevice ( const QString udi)
pure virtual

Instantiates a new Device object from this backend given its UDI.

Parameters
udithe identifier of the device instantiated
Returns
a new Device object if there's a device having the given UDI, 0 otherwise

Implemented in Solid::Backends::Fake::FakeManager.

void Solid::Ifaces::DeviceManager::deviceAdded ( const QString udi)
signal

This signal is emitted when a new device appears in the system.

Parameters
udithe new device identifier
void Solid::Ifaces::DeviceManager::deviceRemoved ( const QString udi)
signal

This signal is emitted when a device disappears from the system.

Parameters
udithe old device identifier
virtual QStringList Solid::Ifaces::DeviceManager::devicesFromQuery ( const QString parentUdi,
Solid::DeviceInterface::Type  type = Solid::DeviceInterface::Unknown 
)
pure virtual

Retrieves the Universal Device Identifier (UDI) of all the devices matching the given constraints (parent and device interface)

Parameters
parentUdiUDI of the parent of the devices we're searching for, or QString() if there's no constraint on the parent
typeDeviceInterface type available on the devices we're looking for, or DeviceInterface::Unknown if there's no constraint on the device interfaces
Returns
the UDIs of all the devices having the given parent and device interface

Implemented in Solid::Backends::Fake::FakeManager.

virtual QSet<Solid::DeviceInterface::Type> Solid::Ifaces::DeviceManager::supportedInterfaces ( ) const
pure virtual

Retrieves a set of interfaces the backend supports.

Implemented in Solid::Backends::Fake::FakeManager.

virtual QString Solid::Ifaces::DeviceManager::udiPrefix ( ) const
pure virtual

Retrieves the prefix used for the UDIs off all the devices reported by the device manager.

Implemented in Solid::Backends::Fake::FakeManager.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue May 26 2020 22:55:11 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.