/**************************************************************************** ** ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the QtBluetooth module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and Digia. For licensing terms and ** conditions see http://qt.digia.com/licensing. For further information ** use the contact form at http://qt.digia.com/contact-us. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser ** General Public License version 2.1 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 2.1 requirements ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, Digia gives you certain additional ** rights. These rights are described in the Digia Qt LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 3.0 as published by the Free Software ** Foundation and appearing in the file LICENSE.GPL included in the ** packaging of this file. Please review the following information to ** ensure the GNU General Public License version 3.0 requirements will be ** met: http://www.gnu.org/copyleft/gpl.html. ** ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #include "qbluetoothlocaldevice.h" #include "qbluetoothlocaldevice_p.h" #include "qbluetoothaddress.h" #include QT_BEGIN_NAMESPACE /*! \class QBluetoothLocalDevice \inmodule QtBluetooth \brief The QBluetoothLocalDevice class enables access to the local Bluetooth device. QBluetoothLocalDevice provides functions for getting and setting the state of local Bluetooth devices. */ /*! \enum QBluetoothLocalDevice::Pairing This enum describes the pairing state between the two Bluetooth devices. \value Unpaired The Bluetooth devices are not paired. \value Paired The Bluetooth devices are paired. The system will prompt the user for authorization when the remote device initiates a connection to the local device. \value AuthorizedPaired The Bluetooth devices are paired. The system will not prompt the user for authorization when the remote device initiates a connection to the local device. */ /*! \enum QBluetoothLocalDevice::Error This enum describes errors that maybe returned \value NoError No known error \value PairingError Error in pairing \value UnknownError Unknown error */ /*! \enum QBluetoothLocalDevice::HostMode This enum describes the most of the local Bluetooth device. \value HostPoweredOff Power off the device \value HostConnectable Remote Bluetooth devices can connect to the local Bluetooth device if they have previously been paired with it or otherwise know its address. This powers up the device if it was powered off. \value HostDiscoverable Remote Bluetooth devices can discover the presence of the local Bluetooth device. The device will also be connectable, and powered on. \value HostDiscoverableLimitedInquiry Remote Bluetooth devices can discover the presence of the local Bluetooth device when performing a limited inquiry. This should be used for locating services that are only made discoverable for a limited period of time. This can speed up discovery between gaming devices, as service discovery can be skipped on devices not in LimitedInquiry mode. In this mode, the device will be connectable and powered on, if required. */ namespace { class LocalDeviceRegisterMetaTypes { public: LocalDeviceRegisterMetaTypes() { qRegisterMetaType("QBluetoothLocalDevice::HostMode"); qRegisterMetaType("QBluetoothLocalDevice::Pairing"); qRegisterMetaType("QBluetoothLocalDevice::Error"); } } _registerLocalDeviceMetaTypes; } /*! Destroys the QBluetoothLocalDevice. */ QBluetoothLocalDevice::~QBluetoothLocalDevice() { delete d_ptr; } /*! Returns true if the QBluetoothLocalDevice represents an available local Bluetooth device; otherwise return false. */ bool QBluetoothLocalDevice::isValid() const { if (d_ptr) return d_ptr->isValid(); return false; } /*! \fn void QBluetoothLocalDevice::setHostMode(QBluetoothLocalDevice::HostMode mode) Sets the host mode of this local Bluetooth device to \a mode. NOTE: Due to security policies of platforms, this method may behave different on different platforms. For example the system can ask the user for confirmation before turning Bluetooth on or off. Not all host modes may be supported on all platforms. Please refer to the platform specific Bluetooth documentation for details. */ /*! \fn QBluetoothLocalDevice::HostMode QBluetoothLocalDevice::hostMode() const Returns the current host mode of this local Bluetooth device. */ /*! \fn QBluetoothLocalDevice::name() const Returns the name assgined by the user to this Bluetooth device. */ /*! \fn QBluetoothLocalDevice::address() const Returns the MAC address of this Bluetooth device. */ /*! \fn QList QBluetoothLocalDevice::allDevices() Returns a list of all available local Bluetooth devices. */ /*! \fn QBluetoothLocalDevice::powerOn() Powers on the device after returning it to the hostMode() state, if it was powered off. NOTE: Due to security policies of platforms, this method may behave different on different platforms. For example the system can ask the user for confirmation before turning Bluetooth on or off. Please refer to the platform specific Bluetooth documentation for details. */ /*! \fn QBluetoothLocalDevice::QBluetoothLocalDevice(QObject *parent) Constructs a QBluetoothLocalDevice with \a parent. */ /*! \fn QBluetoothLocalDevice::hostModeStateChanged(QBluetoothLocalDevice::HostMode state) The \a state of the host has transitioned to a different HostMode. */ /*! \fn QBluetoothLocalDevice::deviceConnected(const QBluetoothAddress &address) \since 5.3 A device with \a address is connected with this device. */ /*! \fn QBluetoothLocalDevice::deviceDisconnected(const QBluetoothAddress &address) \since 5.3 A device with \a address is disconnected from this device. */ /*! \fn QList QBluetoothLocalDevice::connectedDevices() const \since 5.3 Returns the list of connected devices. */ /*! \fn QBluetoothLocalDevice::pairingStatus(const QBluetoothAddress &address) const Returns the current bluetooth pairing status of \a address, if it's unpaired, paired, or paired and authorized. */ /*! \fn QBluetoothLocalDevice::pairingDisplayConfirmation(const QBluetoothAddress &address, QString pin) Signal by some platforms to display a pairing confirmation dialog for \a address. The user is asked to confirm the \a pin is the same on both devices. QBluetoothLocalDevice::pairingConfirmation(bool) must be called to indicate if the user accepts or rejects the displayed pin. */ /*! \fn QBluetoothLocalDevice::pairingConfirmation(bool accept) To be called after getting a pairingDisplayConfirmation(). The \a accept parameter either accepts the pairing or rejects it. */ /*! \fn QBluetoothLocalDevice::pairingDisplayPinCode(const QBluetoothAddress &address, QString pin) Signal by some platforms to display the \a pin to the user for \a address. The pin is automatically generated, and does not need to be confirmed. */ /*! \fn QBluetoothLocalDevice::requestPairing(const QBluetoothAddress &address, Pairing pairing) Set the \a pairing status with \a address. The results are returned by the signal, pairingFinished(). On BlackBerry AuthorizedPaired is not possible and will have the same behavior as Paired. Caution: creating a pairing may take minutes, and may require the user to acknowledge. */ /*! \fn QBluetoothLocalDevice::pairingFinished(const QBluetoothAddress &address, QBluetoothLocalDevice::Pairing pairing) Pairing or unpairing has completed with \a address. Current pairing status is in \a pairing. If the pairing request was not successful, this signal will not be emitted. The error() signal is emitted if the pairing request failed. */ /*! \fn QBluetoothLocalDevice::error(QBluetoothLocalDevice::Error error) Signal emitted if there's an exceptional \a error while pairing. */ /*! \fn QBluetoothLocalDevice::QBluetoothLocalDevice(const QBluetoothAddress &address, QObject *parent = 0) Construct new QBluetoothLocalDevice for \a address. If \a address is default constructed the resulting local device selects the local default device. */ #include "moc_qbluetoothlocaldevice.cpp" QT_END_NAMESPACE