workspace/libs/solid/control/bluetoothremotedevice.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_BLUETOOTHREMOTEDEVICE_H
  24 #define SOLID_CONTROL_BLUETOOTHREMOTEDEVICE_H
  25
  26 #include <QtCore/QObject>
  27 #include <QtCore/QStringList>
  28 #include <QtCore/QMap>
  29 #include <QtCore/QVariant>
  30
  31 #include "bluetoothmanager.h"
  32 #include "bluetoothinterface.h"
  33
  34 class KJob;
  35
  36 namespace Solid
  37 {
  38 namespace Control
  39 {
  40 class BluetoothRemoteDevicePrivate;
  41 /**
  42  * Represents a bluetooth remote device as seen by the bluetoothing subsystem.
  43  */
  44 class SOLIDCONTROL_EXPORT BluetoothRemoteDevice : public QObject
  45 {
  46     Q_OBJECT
  47     Q_DECLARE_PRIVATE(BluetoothRemoteDevice)
  48
  49 public:
  50     /**
  51      * Creates a new BluetoothRemoteDevice object.
  52      *
  53      * @param backendObject the bluetooth remote device object provided by the backend
  54      */
  55     BluetoothRemoteDevice(QObject *backendObject = 0);
  56
  57     /**
  58      * Constructs a copy of a bluetooth remote device.
  59      *
  60      * @param device the bluetooth remote device to copy
  61      */
  62     BluetoothRemoteDevice(const BluetoothRemoteDevice &device);
  63
  64     /**
  65      * Destroys the device.
  66      */
  67     ~BluetoothRemoteDevice();
  68
  69     /**
  70      * Assigns a bluetooth remote device to this bluetooth remote device and returns a reference to it.
  71      *
  72      * @param device the bluetooth remote device to assign
  73      * @return a reference to the bluetooth remote device
  74      */
  75     BluetoothRemoteDevice &operator=(const BluetoothRemoteDevice &device);
  76
  77     /**
  78      * Checks for equality.
  79      * @param other the bluetooth remote device to compare with this
  80      * @return true if this->ubi() equals other.ubi(), false otherwise
  81      */
  82     bool operator==(const BluetoothRemoteDevice  & other) const;
  83
  84     /**
  85      * The UBI of the remote device.
  86      */
  87     QString ubi() const;
  88
  89     /**
  90      * The address of the remote device.
  91      */
  92     QString address();
  93
  94     /**
  95      * The name of the remote device.
  96      */
  97     QString name();
  98
  99     /**
 100      * The icon of the remote device.
 101      */
 102     QString icon();
 103
 104     /**
 105      * The Trust state of the remote device.
 106      */
 107     bool isTrusted();
 108
 109     /**
 110      * Set the Trust state of the remote device.
 111      */
 112     void setTrusted(bool);
 113
 114     /**
 115      * Returns the service uuids of the remote device.
 116      */
 117     QStringList uuids();
 118
 119     /**
 120      * The Connection state of the remote device.
 121      */
 122     bool isConnected();
 123
 124     /**
 125      * Retrieve all properties from the remote device.
 126      *
 127      * @returns a hash of named properties
 128      */
 129     QMap<QString,QVariant> getProperties();
 130
 131     /**
 132      * Discover all available Services from the remote Device.
 133      * When the call is finished serviceDiscoverAvailable is thrown.
 134      *
 135      * @param pattern a service handle pattern to search for
 136      */
 137     void discoverServices(const QString &pattern);
 138
 139     /**
 140      * List all defined Nodes.
 141      *
 142      * @returns a List of ObjectPaths from all defined Nodes
 143      */
 144     QStringList listNodes();
 145
 146 public Q_SLOTS:
 147
 148     /**
 149      * Set a new Value for a named property.
 150      *
 151      * @param name the name of the property
 152      * @param value the new value to be set
 153      */
 154     void setProperty(const QString &name, const QVariant &value);
 155
 156     /**
 157      * Cancel a started service Discovery.
 158      */
 159     void cancelDiscovery();
 160
 161     /**
 162      * Request a disconnect from the remote device.
 163      */
 164     void disconnect();
 165
 166 Q_SIGNALS:
 167
 168     /**
 169      * Search for services is done.
 170      *
 171      * @param status the result of the discovering.
 172      * @param services the discovered Services.
 173      */
 174     void serviceDiscoverAvailable(const QString &status, const QMap<uint,QString> &services);
 175
 176     /**
 177      * A Property for the remote device has changed.
 178      *
 179      * @param name the name of the changed property
 180      * @param value the new value
 181      */
 182     void propertyChanged(const QString &name, const QVariant &value);
 183
 184     /**
 185      * Disconnect to the remote device requested.
 186      */
 187     void disconnectRequested();
 188
 189
 190 protected:
 191     BluetoothRemoteDevicePrivate *d_ptr;
 192
 193 private:
 194     Q_PRIVATE_SLOT(d_func(), void _k_destroyed(QObject *))
 195
 196
 197     QVariant getProperty(const QString &key);
 198 };
 199
 200 } //Control
 201 } //Solid
 202
 203 #endif