workspace/libs/solid/control/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     Copyright (C) 2008 Tom Patzig <tpatzig@suse.de>
   5
   6
   7     This library is free software; you can redistribute it and/or
   8     modify it under the terms of the GNU Library General Public
   9     License version 2 as published by the Free Software Foundation.
  10
  11     This library is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14     Library General Public License for more details.
  15
  16     You should have received a copy of the GNU Library General Public License
  17     along with this library; see the file COPYING.LIB.  If not, write to
  18     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19     Boston, MA 02110-1301, USA.
  20
  21 */
  22
  23 #ifndef SOLID_CONTROL_BLUETOOTHINPUTDEVICE_H
  24 #define SOLID_CONTROL_BLUETOOTHINPUTDEVICE_H
  25
  26 #include <QtCore/QObject>
  27 #include <QtCore/QMap>
  28 #include <QtCore/QVariant>
  29
  30 #include "solid_control_export.h"
  31
  32 namespace Solid
  33 {
  34 namespace Control
  35 {
  36 class BluetoothInputDevicePrivate;
  37
  38 /**
  39  * Represents a bluetooth remote device as seen by the bluetoothing subsystem.
  40  */
  41 class SOLIDCONTROL_EXPORT BluetoothInputDevice : public QObject
  42 {
  43     Q_OBJECT
  44
  45 public:
  46     /**
  47      * Creates a new BluetoothInputDevice object.
  48      *
  49      * @param backendObject the bluetooth remote device object provided by the backend
  50      */
  51     BluetoothInputDevice(QObject *backendObject = 0);
  52
  53     /**
  54      * Constructs a copy of a bluetooth remote device.
  55      *
  56      * @param device the bluetooth remote device to copy
  57      */
  58     BluetoothInputDevice(const BluetoothInputDevice &device);
  59
  60     /**
  61      * Destroys the device.
  62      */
  63     ~BluetoothInputDevice();
  64
  65     /**
  66      * Assigns a bluetooth remote device to this bluetooth remote device and returns a reference to it.
  67      *
  68      * @param device the bluetooth remote device to assign
  69      * @return a reference to the bluetooth remote device
  70      */
  71     BluetoothInputDevice &operator=(const BluetoothInputDevice &device);
  72
  73     /**
  74      * Retrieves the Universal Network Identifier (UBI) of the BluetoothInputDevice.
  75      * This identifier is ubique for each bluetooth and bluetooth remote device in the system.
  76      *
  77      * @returns the Universal Network Identifier of the current bluetooth remote device
  78      */
  79     QString ubi() const;
  80     /**
  81      * Retrieve all properties from the input device.
  82      *
  83      * @returns a hash of named properties
  84      */
  85     QMap<QString,QVariant> getProperties() const;
  86
  87
  88
  89 public Q_SLOTS:
  90     /**
  91      * Connect bluetooth input device.
  92      */
  93     void connect();
  94
  95     /**
  96      * Disconnect bluetooth input device.
  97      */
  98     void disconnect();
  99
 100
 101 Q_SIGNALS:
 102      /**
 103      * A Property for the input device has changed.
 104      *
 105      * @param name the name of the changed property
 106      * @param value the new value
 107      */
 108     void propertyChanged(const QString &name, const QVariant &value);
 109
 110
 111 private:
 112     Q_PRIVATE_SLOT(d, void _k_destroyed(QObject *))
 113
 114     BluetoothInputDevicePrivate * const d;
 115 };
 116
 117 } //Control
 118
 119 } //Solid
 120
 121 //Q_DECLARE_OPERATORS_FOR_FLAGS(Solid::Control::BluetoothInputDevice::Capabilities)
 122
 123 #endif