Solid::Devices

#include <devices.h>

Inheritance diagram for Solid::Devices:

Properties

int count
 
QStringList devices
 
bool empty
 
QString query
 
- Properties inherited from QObject
 objectName
 

Signals

void countChanged (int count) const
 
void deviceAdded (const QString &udi) const
 
void deviceRemoved (const QString &udi) const
 
void devicesChanged (const QStringList &devices) const
 
void emptyChanged (bool empty) const
 
void queryChanged (const QString &query) const
 

Public Slots

QObjectdevice (const QString &udi, const QString &type)
 

Public Member Functions

 Devices (QObject *parent=nullptr)
 
int count () const
 
QStringList devices () const
 
bool isEmpty () const
 
QString query () const
 
void setQuery (const QString &query)
 
- 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

- 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

A class that watches the devices known to the solid system.

It behaves similarly to Solid::DeviceNotifier, but adds some convenience methods which allow it to watch only the devices matching a specified query (formatted for Solid::Predicate).

It is intended to be used from QML like this:

id: allDevices
}
id: networkShares
query: "IS NetworkShare"
}
id: mice
query: "PointingDevice.type == 'Mouse'"
}
text: "Total number of devices: " + allDevices.count
}
text: "NFS url: " + networkShares.device(
networkShares.devices[0], "NetworkShare"
).url
}

Definition at line 58 of file devices.h.

Member Function Documentation

int Solid::Devices::count ( ) const

Retrieves the number of the devices that match the specified query.

Returns
device count
void Solid::Devices::countChanged ( int  count) const
signal

Emitted when the number of devices that match the specified query has changed.

Parameters
countnew device count
QObject * Solid::Devices::device ( const QString udi,
const QString type 
)
slot

Retrieves an interface object to the specified device.

Parameters
udiudi of the desired device
typehow to interpret the device
See also
Solid::Device::asDeviceInterface

Definition at line 204 of file devices.cpp.

void Solid::Devices::deviceAdded ( const QString udi) const
signal

Emitted when a new device matching the specified query arrives.

Parameters
udiUDI of the new device
void Solid::Devices::deviceRemoved ( const QString udi) const
signal

Emitted when a device matching the specified query disappears.

Parameters
udiUDI of the device
QStringList Solid::Devices::devices ( ) const

Retrieves the list of UDIs of the devices that match the specified query.

void Solid::Devices::devicesChanged ( const QStringList devices) const
signal

Emitted when the list of devices that match the specified query has changed.

Parameters
deviceslist of UDIs
void Solid::Devices::emptyChanged ( bool  empty) const
signal

Emitted when the empty property changes.

Parameters
emptyis the device list empty
bool Solid::Devices::isEmpty ( ) const

Retrieves whether there are devices matching the specified query.

Returns
true if there are no matching devices

Definition at line 167 of file devices.cpp.

QString Solid::Devices::query ( ) const

Query to check the devices against.

It needs to be formatted for Solid::Predicate.

See also
Solid::Predicate
void Solid::Devices::queryChanged ( const QString query) const
signal

Emitted when the query has changed.

Parameters
querynew query
void Solid::Devices::setQuery ( const QString query)

Sets the query to filter the devices.

Parameters
querynew query

Definition at line 190 of file devices.cpp.


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 Fri Aug 7 2020 22:47:58 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.