diff options
author | Michael Zanetti <michael.zanetti@nokia.com> | 2011-08-24 14:09:22 +1000 |
---|---|---|
committer | Rohan McGovern <rohan.mcgovern@nokia.com> | 2011-08-24 14:10:36 +1000 |
commit | 29ba8297443cf76d4f647bde329d62c2a567c709 (patch) | |
tree | 88875199053cd88b3b3521c829277f209e815159 /src/bluetooth/qbluetoothlocaldevice.cpp | |
download | qtconnectivity-29ba8297443cf76d4f647bde329d62c2a567c709.tar.gz |
Initial commit.
From qt5connectivity.tar.gz, md5 317c149d6f8c07d09632353188582834
Diffstat (limited to 'src/bluetooth/qbluetoothlocaldevice.cpp')
-rw-r--r-- | src/bluetooth/qbluetoothlocaldevice.cpp | 239 |
1 files changed, 239 insertions, 0 deletions
diff --git a/src/bluetooth/qbluetoothlocaldevice.cpp b/src/bluetooth/qbluetoothlocaldevice.cpp new file mode 100644 index 00000000..8cba00e7 --- /dev/null +++ b/src/bluetooth/qbluetoothlocaldevice.cpp @@ -0,0 +1,239 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** 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, Nokia gives you certain additional +** rights. These rights are described in the Nokia 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. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qbluetoothlocaldevice.h" +#include "qbluetoothlocaldevice_p.h" +#include "qbluetoothaddress.h" + +#include <QtCore/QString> +#include <QDebug> + +/*! + \class QBluetoothLocalDevice + \brief The QBluetoothLocalDevice class provides access to local Bluetooth devices. + + \ingroup connectivity-bluetooth + \inmodule QtConnectivity + \since 5.0 + + QBluetoothLocalDevice provides functions for getting and setting the state of local Bluetooth + devices. +*/ + +/*! + \enum QBluetoothLocalDevice::Pairing + + This enum describes the pairing state between 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 Powers the device down + \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 games for example, since service + discovery can be skipped on devices not in limited enquiry more. This + is not supported on all platforms. The device will also be connectable, and powered on. + +*/ + +namespace +{ +class LocalDeviceRegisterMetaTypes +{ +public: + LocalDeviceRegisterMetaTypes() + { + qRegisterMetaType<QBluetoothLocalDevice::HostMode>("QBluetoothLocalDevice::HostMode"); + qRegisterMetaType<QBluetoothLocalDevice::Pairing>("QBluetoothLocalDevice::Pairing"); + qRegisterMetaType<QBluetoothLocalDevice::Error>("QBluetoothLocalDevice::Error"); + } +} _registerLocalDeviceMetaTypes; +} + +/*! + Destroys the QBluetoothLocalDevice. +*/ +QBluetoothLocalDevice::~QBluetoothLocalDevice() +{ + delete d_ptr; +} + +/*! + Returns true the QBluetoothLocalDevice represents an available local Bluetooth device; + otherwise return false. +*/ +bool QBluetoothLocalDevice::isValid() const +{ + return d_ptr; +} + +/*! + \fn void QBluetoothLocalDevice::setHostMode(QBluetoothLocalDevice::HostMode mode) + + Sets the host mode the this local Bluetooth device to \a mode. +*/ + +/*! + \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> QBluetoothLocalDevice::allDevices() + + Returns a list of all available local Bluetooth devices. +*/ + +/*! + \fn QBluetoothLocalDevice::powerOn() + + Powers on the device on returning it to the hostMode() state is was in when powered down +*/ + +/*! + \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::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 via + the signal pairingFinished(). Caution: creating a pairing may take minutes, and can require + the user to acknowledge dialogs. +*/ + +/*! + \fn QBluetoothLocalDevice::pairingFinished(const QBluetoothAddress &address, QBluetoothLocalDevice::Pairing pairing) + + Pairing has completed with \a address. Current pairing status is in \a pairing. +*/ + +/*! + \fn QBluetoothLocalDevice::error(QBluetoothLocalDevice::Error error) + Signal emitted for pairing if there's an exceptional \a error +*/ + + +/*! + \fn QBluetoothLocalDevice::QBluetoothLocalDevice(const QBluetoothAddress &address, QObject *parent = 0) + + Construct new QBluetoothLocalDevice for \a address. +*/ + + +#include "moc_qbluetoothlocaldevice.cpp" |