workspace/libs/solid/control/ifaces/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
   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_BLUETOOTHREMOTEDEVICE
  23 #define SOLID_IFACES_BLUETOOTHREMOTEDEVICE
  24
  25 #include <QtCore/QObject>
  26 #include <QtCore/QStringList>
  27 #include "../solid_control_export.h"
  28
  29 class KJob;
  30
  31 namespace Solid
  32 {
  33 namespace Control
  34 {
  35 namespace Ifaces
  36 {
  37 /**
  38  * This interface represents a remote bluetooth device which we may be connected to.
  39  */
  40 class SOLIDCONTROLIFACES_EXPORT BluetoothRemoteDevice : public QObject
  41 {
  42     Q_OBJECT
  43 public:
  44     /**
  45      * Create a BluetoothRemoteDevice.
  46      *
  47      * @param parent the parent object
  48      */
  49     BluetoothRemoteDevice(QObject *parent = 0);
  50
  51     /**
  52      * Destructs a BluetoothRemoteDevice object.
  53      */
  54     virtual ~BluetoothRemoteDevice();
  55     /**
  56      * Retrieve all properties from the remote device.
  57      *
  58      * @returns a hash of named properties
  59      */
  60     virtual QMap<QString,QVariant> getProperties() const = 0;
  61     /**
  62      * Discover all available Services from the remote Device.
  63      * When the call is finished serviceDiscoverAvailable is thrown.
  64      *
  65      * @param pattern a service handle pattern to search for
  66      */
  67     virtual void discoverServices(const QString &pattern) const = 0;
  68     /**
  69      * List all defined Nodes.
  70      *
  71      * @returns a List of ObjectPaths from all defined Nodes
  72      */
  73     virtual QStringList listNodes() const = 0;
  74     /**
  75      * The UBI of the remote device.
  76      */
  77     virtual QString ubi() const = 0;
  78
  79
  80 public Q_SLOTS:
  81     /**
  82      * Set a new Value for a named property.
  83      *
  84      * @param name the name of the property
  85      * @param value the new value to be set
  86      */
  87     virtual void setProperty(const QString &name, const QVariant &value) = 0;
  88     /**
  89      * Cancel a started service Discovery.
  90      */
  91     virtual void cancelDiscovery() = 0;
  92     /**
  93      * Request a disconnect from the remote device.
  94      */
  95     virtual void disconnect() = 0;
  96
  97
  98
  99 Q_SIGNALS:
 100     /**
 101      * Search for services is done.
 102      *
 103      * @param status the result of the discovering.
 104      * @param services the discovered Services.
 105      */
 106     virtual void serviceDiscoverAvailable(const QString &status, const QMap<uint,QString> &services) = 0;
 107     /**
 108      * A Property for the remote device has changed.
 109      *
 110      * @param name the name of the changed property
 111      * @param value the new value
 112      */
 113     virtual void propertyChanged(const QString &name, const QVariant &value) = 0;
 114     /**
 115      * Disconnect to the remote device requested.
 116      */
 117     virtual void disconnectRequested() = 0;
 118
 119
 120
 121 };
 122
 123 } // Ifaces
 124
 125 } // Control
 126
 127 } // Solid
 128
 129 Q_DECLARE_INTERFACE(Solid::Control::Ifaces::BluetoothRemoteDevice, "org.kde.Solid.Control.Ifaces.BluetoothRemoteDevice/0.1")
 130
 131 #endif