MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QBluetoothLocalDevice Class Reference

The QBluetoothLocalDevice class provides access to local Bluetooth devices. More...

 #include <QBluetoothLocalDevice>

Inherits: QObject.

This class was introduced in Qt Mobility 1.2.

Public Types

enum Error { NoError, PairingError, UnknownError }
enum HostMode { HostPoweredOff, HostConnectable, HostDiscoverable, HostDiscoverableLimitedInquiry }
enum Pairing { Unpaired, Paired, AuthorizedPaired }

Public Functions

QBluetoothLocalDevice ( QObject * parent = 0 )
QBluetoothLocalDevice ( const QBluetoothAddress & address, QObject * parent = 0 )
virtual ~QBluetoothLocalDevice ()
QBluetoothAddress address () const
HostMode hostMode () const
bool isValid () const
QString name () const
Pairing pairingStatus ( const QBluetoothAddress & address ) const
void powerOn ()
void requestPairing ( const QBluetoothAddress & address, Pairing pairing )
void setHostMode ( QBluetoothLocalDevice::HostMode mode )
  • 29 public functions inherited from QObject

Public Slots

void pairingConfirmation ( bool accept )
  • 1 public slot inherited from QObject

Signals

void error ( QBluetoothLocalDevice::Error error )
void hostModeStateChanged ( QBluetoothLocalDevice::HostMode state )
void pairingDisplayConfirmation ( const QBluetoothAddress & address, QString pin )
void pairingDisplayPinCode ( const QBluetoothAddress & address, QString pin )
void pairingFinished ( const QBluetoothAddress & address, QBluetoothLocalDevice::Pairing pairing )

Static Public Members

QList<QBluetoothHostInfo> allDevices ()
  • 4 static public members inherited from QObject

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public variable inherited from QObject
  • 7 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QBluetoothLocalDevice class provides access to local Bluetooth devices.

QBluetoothLocalDevice provides functions for getting and setting the state of local Bluetooth devices.

Member Type Documentation

enum QBluetoothLocalDevice::Error

This enum describes errors that maybe returned

Constant Value Description
QBluetoothLocalDevice::NoError 0 No known error
QBluetoothLocalDevice::PairingError 1 Error in pairing
QBluetoothLocalDevice::UnknownError 100 Unknown error

enum QBluetoothLocalDevice::HostMode

This enum describes the most of the local Bluetooth device.

Constant Value Description
QBluetoothLocalDevice::HostPoweredOff 0 Powers the device down
QBluetoothLocalDevice::HostConnectable 1 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.
QBluetoothLocalDevice::HostDiscoverable 2 Remote Bluetooth devices can discover the presence of the local Bluetooth device. The device will also be connectable, and powered on.
QBluetoothLocalDevice::HostDiscoverableLimitedInquiry 3 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.

enum QBluetoothLocalDevice::Pairing

This enum describes the pairing state between two Bluetooth devices.

Constant Value Description
QBluetoothLocalDevice::Unpaired 0 The Bluetooth devices are not paired.
QBluetoothLocalDevice::Paired 1 The Bluetooth devices are paired. The system will prompt the user for authorization when the remote device initiates a connection to the local device.
QBluetoothLocalDevice::AuthorizedPaired 2 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.

Member Function Documentation

QBluetoothLocalDevice::QBluetoothLocalDevice ( QObject * parent = 0 )

Constructs a QBluetoothLocalDevice with parent.

QBluetoothLocalDevice::QBluetoothLocalDevice ( const QBluetoothAddress & address, QObject * parent = 0 )

Construct new QBluetoothLocalDevice for address.

QBluetoothLocalDevice::~QBluetoothLocalDevice () [virtual]

Destroys the QBluetoothLocalDevice.

QBluetoothAddress QBluetoothLocalDevice::address () const

Returns the MAC address of this Bluetooth device.

QList<QBluetoothHostInfo> QBluetoothLocalDevice::allDevices () [static]

Returns a list of all available local Bluetooth devices.

void QBluetoothLocalDevice::error ( QBluetoothLocalDevice::Error error ) [signal]

Signal emitted for pairing if there's an exceptional error

HostMode QBluetoothLocalDevice::hostMode () const

Returns the current host mode of this local Bluetooth device.

See also setHostMode().

void QBluetoothLocalDevice::hostModeStateChanged ( QBluetoothLocalDevice::HostMode state ) [signal]

The state of the host has transitioned to a different HostMode

bool QBluetoothLocalDevice::isValid () const

Returns true the QBluetoothLocalDevice represents an available local Bluetooth device; otherwise return false.

QString QBluetoothLocalDevice::name () const

Returns the name assgined by the user to this Bluetooth device.

void QBluetoothLocalDevice::pairingConfirmation ( bool accept ) [slot]

To be called after getting a pairingDisplayConfirmation(). The accept parameter either accepts the pairing or rejects it.

void QBluetoothLocalDevice::pairingDisplayConfirmation ( const QBluetoothAddress & address, QString pin ) [signal]

Signal by some platforms to display a pairing confirmation dialog for address. The user is asked to confirm the pin is the same on both devices. QBluetoothLocalDevice::pairingConfirmation(bool) must be called to indicate if the user accepts or rejects the displayed pin.

void QBluetoothLocalDevice::pairingDisplayPinCode ( const QBluetoothAddress & address, QString pin ) [signal]

Signal by some platforms to display the pin to the user for address. The pin is automatically generated, and does not need to be confirmed.

void QBluetoothLocalDevice::pairingFinished ( const QBluetoothAddress & address, QBluetoothLocalDevice::Pairing pairing ) [signal]

Pairing has completed with address. Current pairing status is in pairing.

Pairing QBluetoothLocalDevice::pairingStatus ( const QBluetoothAddress & address ) const

Returns the current bluetooth pairing status of address, if it's unpaired, paired, or paired and authorized.

void QBluetoothLocalDevice::powerOn ()

Powers on the device on returning it to the hostMode() state is was in when powered down

void QBluetoothLocalDevice::requestPairing ( const QBluetoothAddress & address, Pairing pairing )

Set the pairing status with address. The results are returned via the signal pairingFinished(). Caution: creating a pairing may take minutes, and can require the user to acknowledge dialogs.

void QBluetoothLocalDevice::setHostMode ( QBluetoothLocalDevice::HostMode mode )

Sets the host mode the this local Bluetooth device to mode.

See also hostMode().