workspace/libs/solid/control/ifaces/bluetoothmanager.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_BLUETOOTHMANAGER
  23 #define SOLID_IFACES_BLUETOOTHMANAGER
  24
  25 #include <QtCore/QObject>
  26 #include <solid/control/solid_control_export.h>
  27
  28 class KJob;
  29
  30 namespace Solid
  31 {
  32 namespace Control
  33 {
  34 namespace Ifaces
  35 {
  36 class BluetoothSecurity;
  37 /**
  38  * This class specifies the interface a backend will have to implement in
  39  * order to be used in the system.
  40  *
  41  * A bluetooth manager allow to query the underlying platform to discover the
  42  * available bluetooth interfaces.
  43  */
  44 class SOLIDCONTROLIFACES_EXPORT BluetoothManager : public QObject
  45 {
  46     Q_OBJECT
  47 public:
  48     /**
  49      * Constructs a BluetoothManager.
  50      *
  51      * @param parent the parent object
  52      */
  53     BluetoothManager(QObject * parent = 0);
  54     /**
  55      * Destructs a BluetoothManager object.
  56      */
  57     virtual ~BluetoothManager();
  58
  59     /**
  60      * Retrieves the list of all the bluetooth interfaces Universal Bluetooth Identifiers (UBIs)
  61      * in the system.
  62      *
  63      * @return the list of bluetooth interfaces available in this system
  64      */
  65     virtual QStringList bluetoothInterfaces() const = 0;
  66
  67     /**
  68      * Retrieves the default bluetooth interface Universal Bluetooth Identifiers (UBIs)
  69      * of the system.
  70      *
  71      * @return the UBI of the default bluetooth interface
  72      */
  73     virtual QString defaultInterface() const = 0;
  74
  75     /**
  76      * Instantiates a new BluetoothInterface object from this backend given its UBI.
  77      *
  78      * @param ubi the identifier of the bluetooth interface instantiated
  79      * @returns a new BluetoothInterface object if there's a device having the given UBI, 0 otherwise
  80      */
  81     virtual QObject *createInterface(const QString &ubi) = 0;
  82
  83     /**
  84      * Retrieves the list of Universal Bluetooth Identifiers (UBIs) of bluetooth input devices
  85      * which are configured in the system. Configured means also not connected devices.
  86      *
  87      * @return the list of bluetooth input devices configured in this system
  88      */
  89     virtual QStringList bluetoothInputDevices() const = 0;
  90
  91     /**
  92      * Instantiates a new BluetoothInputDevice object from this backend given its UBI.
  93      *
  94      * @param ubi the identifier of the bluetooth input device instantiated
  95      * @returns a new BluetoothInputDevice object if there's a device having the given UBI, 0 otherwise
  96      */
  97     virtual QObject *createBluetoothInputDevice(const QString &ubi) = 0;
  98
  99     /**
 100      * Setup a new bluetooth input device.
 101      *
 102      * @param ubi the ubi of the bluetooth input device
 103      * @returns job handling of the operation.
 104      */
 105     virtual KJob *setupInputDevice(const QString &ubi) = 0;
 106
 107     /**
 108      * Gets an instance of BluetoothSecurity to handle pairing/authorization requests
 109      */
 110     virtual Solid::Control::Ifaces::BluetoothSecurity* security(const QString &interface) = 0;
 111
 112 public Q_SLOTS:
 113     /**
 114      * Remove the configuraiton of a bluetooth input device.
 115      *
 116      * @param ubi the bluetooth input device identifier
 117      */
 118     virtual void removeInputDevice(const QString  & ubi) = 0;
 119
 120 Q_SIGNALS:
 121     /**
 122      * This signal is emitted when a new bluetooth interface is available.
 123      *
 124      * @param ubi the bluetooth interface identifier
 125      */
 126     void interfaceAdded(const QString  & ubi);
 127
 128     /**
 129      * This signal is emitted when a bluetooth interface is not available anymore.
 130      *
 131      * @param ubi the bluetooth interface identifier
 132      */
 133     void interfaceRemoved(const QString  & ubi);
 134
 135     /**
 136      * This signal is emitted when the default bluetooth interface changed.
 137      *
 138      * @param ubi the bluetooth interface identifier
 139      */
 140     void defaultInterfaceChanged(const QString  & ubi);
 141
 142     /**
 143      * This signal is emitted when a new bluetooth input device got configured/created.
 144      *
 145      * @param ubi the bluetooth input device identifier
 146      */
 147     void inputDeviceCreated(const QString  & ubi);
 148
 149     /**
 150      * This signal is emitted when a bluetooth input device configuration is not available anymore.
 151      *
 152      * @param ubi the bluetooth input device identifier
 153      */
 154     void inputDeviceRemoved(const QString  & ubi);
 155
 156 };
 157
 158 } // Ifaces
 159
 160 } // Control
 161
 162 } // Solid
 163
 164 #endif