ifaces/genericinterface.h

/*
    SPDX-FileCopyrightText: 2006 Kevin Ottens <ervin@kde.org>
 
    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
 
#ifndef SOLID_IFACES_GENERICINTERFACE_H
#define SOLID_IFACES_GENERICINTERFACE_H
 
#include <QObject>
 
#include <QMap>
#include <QVariant>
 
namespace Solid
{
namespace Ifaces
{
/**
 * Generic interface to deal with a device. It exposes a set of properties
 * and is organized a 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.
 */
class GenericInterface
{
public:
    /**
     * Destroys a GenericInterface object.
     */
    virtual ~GenericInterface();
 
    /**
     * Retrieves the value of a property.
     *
     * @param key the property name
     * @returns the property value or QVariant() if the property doesn't exist
     */
    virtual QVariant property(const QString &key) const = 0;
 
    /**
     * Retrieves all the properties of this device.
     *
     * @returns all properties in a map
     */
    virtual QMap<QString, QVariant> allProperties() const = 0;
 
    /**
     * Tests if a property exist.
     *
     * @param key the property name
     * @returns true if the property exists in this device, false otherwise
     */
    virtual bool propertyExists(const QString &key) const = 0;
 
protected:
    // Q_SIGNALS:
    /**
     * 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
     */
    virtual void propertyChanged(const QMap<QString, int> &changes) = 0;
 
    /**
     * 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
     */
    virtual void conditionRaised(const QString &condition, const QString &reason) = 0;
};
}
}
 
Q_DECLARE_INTERFACE(Solid::Ifaces::GenericInterface, "org.kde.Solid.Ifaces.GenericInterface/0.1")
 
#endif