device.h

Go to the documentation of this file.

/*
    Copyright 2005-2007 Kevin Ottens <ervin@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) version 3, or any
    later version accepted by the membership of KDE e.V. (or its
    successor approved by the membership of KDE e.V.), which shall
    act as a proxy defined in Section 6 of version 3 of the license.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef SOLID_DEVICE_H
#define SOLID_DEVICE_H

#include <QtCore/QVariant>

#include <QtCore/QMap>
#include <QtCore/QList>
#include <QtCore/QSharedData>

#include <solid/solid_export.h>

#include <solid/deviceinterface.h>

namespace Solid
{
    class DevicePrivate;

    class SOLID_EXPORT Device
    {
    public:
        static QList<Device> allDevices();

        static QList<Device> listFromType(const DeviceInterface::Type &type,
                                          const QString &parentUdi = QString());

        static QList<Device> listFromQuery(const Predicate &predicate,
                                           const QString &parentUdi = QString());

        static QList<Device> listFromQuery(const QString &predicate,
                                           const QString &parentUdi = QString());


        explicit Device(const QString &udi = QString());

        Device(const Device &device);

        ~Device();



        Device &operator=(const Device &device);

        bool isValid() const;


        QString udi() const;

        QString parentUdi() const;


        Device parent() const;



        QString vendor() const;

        QString product() const;

        QString icon() const;

        QStringList emblems() const;

        QString description() const;

        bool isDeviceInterface(const DeviceInterface::Type &type) const;

        DeviceInterface *asDeviceInterface(const DeviceInterface::Type &type);

        const DeviceInterface *asDeviceInterface(const DeviceInterface::Type &type) const;

        template <class DevIface> DevIface *as()
        {
            DeviceInterface::Type type = DevIface::deviceInterfaceType();
            DeviceInterface *iface = asDeviceInterface(type);
            return qobject_cast<DevIface *>(iface);
        }

        template <class DevIface> const DevIface *as() const
        {
            DeviceInterface::Type type = DevIface::deviceInterfaceType();
            const DeviceInterface *iface = asDeviceInterface(type);
            return qobject_cast<const DevIface *>(iface);
        }

        template <class DevIface> bool is() const
        {
            return isDeviceInterface(DevIface::deviceInterfaceType());
        }

    private:
        QExplicitlySharedDataPointer<DevicePrivate> d;
        friend class DeviceManagerPrivate;
    };
}

#endif