workspace/libs/solid/control/ifaces/bluetoothinputdevice.h

   1 /*  This file is part of the KDE project
   2     Copyright (C) 2007 Will Stephenson <wstephenson@kde.org>
   3     Copyright (C) 2007 Daniel Gollub <dgollub@suse.de>
   4
   5
   6     This library is free software; you can redistribute it and/or
   7     modify it under the terms of the GNU Library General Public
   8     License version 2 as published by the Free Software Foundation.
   9
  10     This library is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13     Library General Public License for more details.
  14
  15     You should have received a copy of the GNU Library General Public License
  16     along with this library; see the file COPYING.LIB.  If not, write to
  17     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18     Boston, MA 02110-1301, USA.
  19
  20 */
  21
  22 #ifndef SOLID_IFACES_BLUETOOTHINPUTDEVICE
  23 #define SOLID_IFACES_BLUETOOTHINPUTDEVICE
  24
  25 #include <QtCore/QObject>
  26 #include <QtCore/QMap>
  27 #include <QtCore/QVariant>
  28
  29 #include "../solid_control_export.h"
  30
  31 namespace Solid
  32 {
  33 namespace Control
  34 {
  35 namespace Ifaces
  36 {
  37 /**
  38  * A BluetoothInputDevice object allows to manage the connection of a bluetooth input device.
  39  */
  40 class SOLIDCONTROLIFACES_EXPORT BluetoothInputDevice : public QObject
  41 {
  42     Q_OBJECT
  43 public:
  44     /**
  45      * Constructs a BluetoothInputDevice.
  46      *
  47      * @param parent the parent object
  48      */
  49     BluetoothInputDevice(QObject * parent = 0);
  50
  51     /**
  52      * Destructs a BluetoothInputDevice object.
  53      */
  54     virtual ~BluetoothInputDevice();
  55
  56     /**
  57      * Retrieves ubi of bluetooth input device.
  58      *
  59      * @returns ubi of bluetooth input device
  60      */
  61     virtual QString ubi() const = 0;
  62     /**
  63      * Retrieve all properties from the input device.
  64      *
  65      * @returns a hash of named properties
  66      */
  67     virtual QMap<QString,QVariant> getProperties() const = 0;
  68
  69
  70 public Q_SLOTS:
  71     /**
  72      * Connect bluetooth input device.
  73      */
  74     virtual void connect() = 0;
  75
  76     /**
  77      * Disconnect bluetooth input device.
  78      */
  79     virtual void disconnect() = 0;
  80
  81 Q_SIGNALS:
  82      /**
  83      * A Property for the input device has changed.
  84      *
  85      * @param name the name of the changed property
  86      * @param value the new value
  87      */
  88     virtual void propertyChanged(const QString &name, const QVariant &value) = 0;
  89
  90 };
  91
  92 } // Ifaces
  93
  94 } // Control
  95
  96 } // Solid
  97
  98 Q_DECLARE_INTERFACE(Solid::Control::Ifaces::BluetoothInputDevice, "org.kde.Solid.Control.Ifaces.BluetoothInputDevice/0.1")
  99
 100 #endif