Solid::GenericInterface Class
class Solid::GenericInterface| Header: | #include <GenericInterface> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS Solid)target_link_libraries(mytarget PRIVATE KF6::Solid) |
| Inherits: | Solid::DeviceInterface |
Public Types
| enum | PropertyChange { PropertyModified, PropertyAdded, PropertyRemoved } |
Public Functions
| virtual | ~GenericInterface() override |
| QMap<QString, QVariant> | allProperties() const |
| QVariant | property(const QString &key) const |
| bool | propertyExists(const QString &key) const |
Signals
| void | conditionRaised(const QString &condition, const QString &reason) |
| void | propertyChanged(const QMap<QString, int> &changes) |
Static Public Members
| Solid::DeviceInterface::Type | deviceInterfaceType() |
Detailed Description
@class Solid::GenericInterface genericinterface.h <Solid/GenericInterface>
Generic interface to deal with a device. It exposes a set of properties and is organized as a key/value set.
Warning: Using this class could expose some backend specific details and lead to non portable code. Use it at your own risk, or during transitional phases when the provided device interfaces don't provide the necessary methods.
Member Type Documentation
enum GenericInterface::PropertyChange
This enum type defines the type of change that can occur to a GenericInterface property.
- PropertyModified : A property value has changed in the device - PropertyAdded : A new property has been added to the device - PropertyRemoved : A property has been removed from the device
Member Function Documentation
[override virtual noexcept] GenericInterface::~GenericInterface()
Destroys a Processor object.
QMap<QString, QVariant> GenericInterface::allProperties() const
Retrieves a key/value map of all the known properties for the device.
Warning: Using this method could expose some backend specific details and lead to non portable code. Use it at your own risk, or during transitional phases when the provided device interfaces don't provide the necessary methods.
@return all the properties of the device
[signal] void GenericInterface::conditionRaised(const QString &condition, const QString &reason)
This signal is emitted when an event occurred in the device. For example when a button is pressed.
@param condition the condition name @param reason a message explaining why the condition has been raised
[static] Solid::DeviceInterface::Type GenericInterface::deviceInterfaceType()
Get the Solid::DeviceInterface::Type of the GenericInterface device interface.
@return the Processor device interface type @see Solid::Ifaces::Enums::DeviceInterface::Type
QVariant GenericInterface::property(const QString &key) const
Retrieves a property of the device.
Warning: Using this method could expose some backend specific details and lead to non portable code. Use it at your own risk, or during transitional phases when the provided device interfaces don't provide the necessary methods.
@param key the property key @return the actual value of the property, or QVariant() if the property is unknown
[signal] void GenericInterface::propertyChanged(const QMap<QString, int> &changes)
This signal is emitted when a property is changed in the device.
@param changes the map describing the property changes that occurred in the device, keys are property name and values describe the kind of change done on the device property (added/removed/modified), it's one of the type Solid::Device::PropertyChange
bool GenericInterface::propertyExists(const QString &key) const
Tests if a property exist in the device.
Warning: Using this method could expose some backend specific details and lead to non portable code. Use it at your own risk, or during transitional phases when the provided device interfaces don't provide the necessary methods.
@param key the property key @return true if the property is available in the device, false otherwise