• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

libsolidcontrol

Solid::Control::Ifaces::BluetoothInterface

Solid::Control::Ifaces::BluetoothInterface Class Reference

Represents a bluetooth interface as seen by the bluetooth subsystem. More...

#include <bluetoothinterface.h>

Inheritance diagram for Solid::Control::Ifaces::BluetoothInterface:

Inheritance graph
[legend]

List of all members.


Signals

void deviceCreated (const QString &ubi)
void deviceDisappeared (const QString &address)
void deviceFound (const QString &address, const QMap< QString, QVariant > &properties)
void deviceRemoved (const QString &ubi)
void propertyChanged (const QString &property, const QVariant &value)

Public Member Functions

 BluetoothInterface (QObject *parent=0)
virtual void cancelDeviceCreation (const QString &)=0
virtual QObject * createBluetoothInputDevice (const QString &ubi)=0
virtual QObject * createBluetoothRemoteDevice (const QString &ubi)=0
virtual void createDevice (const QString &) const =0
virtual void createPairedDevice (const QString &, const QString &, const QString &) const =0
virtual QString findDevice (const QString &) const =0
virtual QMap< QString, QVariant > getProperties () const =0
virtual QStringList listDevices () const =0
virtual void registerAgent (const QString &, const QString &)=0
virtual void releaseSession ()=0
virtual void removeDevice (const QString &)=0
virtual void requestSession ()=0
virtual void setProperty (const QString &, const QVariant &)=0
virtual void startDiscovery ()=0
virtual void stopDiscovery ()=0
virtual QString ubi () const =0
virtual void unregisterAgent (const QString &)=0
virtual ~BluetoothInterface ()

Detailed Description

Represents a bluetooth interface as seen by the bluetooth subsystem.

Definition at line 42 of file ifaces/bluetoothinterface.h.


Constructor & Destructor Documentation

Solid::Control::Ifaces::BluetoothInterface::BluetoothInterface ( QObject *  parent = 0  ) 

Create a BluetoothInterface.

Parameters:
parent the parent object

Definition at line 24 of file ifaces/bluetoothinterface.cpp.

Solid::Control::Ifaces::BluetoothInterface::~BluetoothInterface (  )  [virtual]

Destructs a BluetoothInterface object.

Definition at line 28 of file ifaces/bluetoothinterface.cpp.


Member Function Documentation

virtual void Solid::Control::Ifaces::BluetoothInterface::cancelDeviceCreation ( const QString &   )  [pure virtual]

virtual QObject* Solid::Control::Ifaces::BluetoothInterface::createBluetoothInputDevice ( const QString &  ubi  )  [pure virtual]

virtual QObject* Solid::Control::Ifaces::BluetoothInterface::createBluetoothRemoteDevice ( const QString &  ubi  )  [pure virtual]

Set mode of bluetooth interface/adapter.

Valid modes, see mode()

Parameters:
mode the mode of the bluetooth interface/adapter Set discoverable timeout of bluetooth interface/adapter.
timeout timeout in seconds Set minor class of bluetooth interface/adapter.
minor set minor class. Valid mode see listAvaliableMinorClasses() Set name of bluetooth interface/adapter.
name the name of bluetooth interface/adapter Start discovery of remote bluetooth devices with device name resolving. Start discovery of remote bluetooth devices without device name resolving. Cancel discovery of remote bluetooth devices. Start periodic discovery of remote bluetooth devices. See stopPeriodicDiscovery() Stop periodic discovery of remote bluetooth devices. Enable/Disable name resolving of remote bluetooth devices in periodic discovery.
resolveName true to enable name resolving otherwise false Instantiates a new BluetoothRemoteDevice object from this backend given its address.
ubi the identifier of the bluetooth remote device instantiated
Returns:
a new BluetoothRemoteDevice object if there's a device having the given UBI, 0 otherwise

Implemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::createDevice ( const QString &   )  const [pure virtual]

virtual void Solid::Control::Ifaces::BluetoothInterface::createPairedDevice ( const QString &  ,
const QString &  ,
const QString &   
) const [pure virtual]

Retrieves the MAC address of the bluetooth interface/adapter.

Returns:
MAC address of bluetooth interface Retrieves the version of the chip of the bluetooth interface/adapter. Example: "Bluetooth 2.0 + EDR"

bluetooth chip version Retrieves the revision of the chip of the bluetooth interface/adapter. Example: "HCI 19.2"

bluetooth chip revision Retrieves the name of the bluetooth chip manufacturer. Example: "Cambdirge Silicon Radio"

manufacturer string of bluetooth interface/adapter Retrieves the name of the bluetooth chip company. Based on device address.

company string of bluetooth interface/adapter Retrieves the current mode of the bluetooth interface/adapter. Valid modes: "off", "connectable", "discoverable"

Todo:
determine unify type for valid modes.. enum?! what about other bluetooth APIs? three modes?
Returns:
current mode of bluetooth interface/adaoter Retrieves the discoverable timeout of the bluetooth interface/adapter. Discoverable timeout of 0 means never disappear.

current discoverable timeout in seconds Retrieves the current discoverable staut of the bluetooth interface/adapter.

current discoverable status of bluetooth interface/adapter List all UBIs of connected remote bluetooth devices of this handled bluetooth interface/adapter.

list UBIs of connected bluetooth remote devices Retrieves major class of the bluetooth interface/adapter.

current major class of the bluetooth interface/adapter List supported minor classes of the bluetooth interface/adapter.

list of supported minor classes by bluetooth interface/adapter Retrievies minor class of the bluetooth interface/adapter. Valid classes, see listAvailableMinorClasses()

minor class of the bluetooth interface/adapter. List services class of the bluetooth interface/adapter.

list of service classes or empty list if no services registered Retrieves name of bluetooth interface/adapter.

name of bluetooth interface/adapter Returns the name of the remote device, given its mac address (mac).

the name of the remote device List UBIs of bonded/paired remote bluetooth devices with this bluetooth interface/adapter.

UBIs of bonded/paired bluetooth remote devices Periodic discovery status of this bluetooth interface/adapter.

true if periodic discovery is already active otherwise false Name resolving status of periodic discovery routing.

true if name got resolved while periodic discovery of this bluetooth interface/adapter List the Universal Bluetooth Identifier (UBI) of all known remote devices, which are seen, used or paired/bonded.

See listConnections()

Returns:
a QStringList of UBIs of all known remote bluetooth devices List the Universal Bluetooth Identifier (UBI) of all known remote devices since a specific datestamp. Known remote devices means remote bluetooth which are seen, used or paired/bonded.
See listConnections(), listRemoteDevices()

Parameters:
date the datestamp of the beginning of recent used devices
Returns:
a QStringList of UBIs of all known remote bluetooth devices Returns true if the remote bluetooth device is trusted otherwise false.
Parameters:
mac the address of the remote device

void Solid::Control::Ifaces::BluetoothInterface::deviceCreated ( const QString &  ubi  )  [signal]

This signal is emitted if the mode of the bluetooth interface/adapter has changed.

See mode() for valid modes.

Parameters:
mode the changed mode The signal is emitted if the discoverable timeout of the bluetooth interface/adapter has changed.
timeout the changed timeout in seconds The signal is emitted if the minor class of the bluetooth interface/adapter has changed.
minor the new minor class The signal is emitted if the name of the bluetooth interface/adapter has changed.
name the new name of the device This signal is emitted if a discovery has started. This signal is emitted if a discovery has completed. This signal is emitted if the bluetooth interface/adapter detects a new remote bluetooth device.
Todo:
change arguments types of deviceClass (uint32) and rssi (int16)
Parameters:
ubi the new bluetooth identifier
deviceClass the device Class of the remote device
rssi the RSSI link of the remote device This signal is emitted if the bluetooth interface/adapter detectes a bluetooth device disappeared.
ubi the ubi of the disappering bluetooth remote device This signal is emitted if the bluetooth interface/adapter detectes a new name for a bluetooth device.
address the address of the bluetooth remote device
name the name of the bluetooth remote device This signal is emitted if a bluetooth connection has been created.
address the address of the connected bluetooth remote device This signal is emitted if a bluetooth connection has been terminated.
address the address of the disconnected bluetooth remote device This signal is emitted if a bluetooth device was set trusted.
address the address of the trusted bluetooth remote device This signal is emitted if the trust to the bluetooth device was removed.
address the address of the bluetooth remote device This signal is emitted if a successful bonding has been created.
address the address of the bluetooth remote device This signal is emitted if the bonding to a bluetooth device has been removed.
address the address of the bluetooth remote device This signal is emitted when a remote device is created.
ubi the object path of the device on the system bus

void Solid::Control::Ifaces::BluetoothInterface::deviceDisappeared ( const QString &  address  )  [signal]

This signal is emitted when an inquiry session for a periodic discovery finishes and previously found devices are no longer in range or visible.

Parameters:
address the address of the remote device

void Solid::Control::Ifaces::BluetoothInterface::deviceFound ( const QString &  address,
const QMap< QString, QVariant > &  properties 
) [signal]

This signal will be emitted every time an inquiry result has been found by the service daemon.

In general they only appear during a device discovery.

Parameters:
address the address of the remote device
properties the properties of the remote device

void Solid::Control::Ifaces::BluetoothInterface::deviceRemoved ( const QString &  ubi  )  [signal]

This signal is emitted when a remote device is removed from the system bus.

Parameters:
ubi the object path on the system bus from the remote device

virtual QString Solid::Control::Ifaces::BluetoothInterface::findDevice ( const QString &   )  const [pure virtual]

virtual QMap< QString, QVariant > Solid::Control::Ifaces::BluetoothInterface::getProperties (  )  const [pure virtual]

virtual QStringList Solid::Control::Ifaces::BluetoothInterface::listDevices (  )  const [pure virtual]

void Solid::Control::Ifaces::BluetoothInterface::propertyChanged ( const QString &  property,
const QVariant &  value 
) [signal]

This signal is emitted when a property of the adapter is set to a new value.

Parameters:
property the named property of the adapter the new value for the property

virtual void Solid::Control::Ifaces::BluetoothInterface::registerAgent ( const QString &  ,
const QString &   
) [pure virtual]

Marks the device as trusted.

Parameters:
mac the address of the remote device Marks the device as not trusted.
mac the address of the remote device

virtual void Solid::Control::Ifaces::BluetoothInterface::releaseSession (  )  [pure virtual]

virtual void Solid::Control::Ifaces::BluetoothInterface::removeDevice ( const QString &   )  [pure virtual]

virtual void Solid::Control::Ifaces::BluetoothInterface::requestSession (  )  [pure virtual]

virtual void Solid::Control::Ifaces::BluetoothInterface::setProperty ( const QString &  ,
const QVariant &   
) [pure virtual]

virtual void Solid::Control::Ifaces::BluetoothInterface::startDiscovery (  )  [pure virtual]

virtual void Solid::Control::Ifaces::BluetoothInterface::stopDiscovery (  )  [pure virtual]

virtual QString Solid::Control::Ifaces::BluetoothInterface::ubi (  )  const [pure virtual]

Retrieves the Universal Bluetooth Identifier (UBI) of the BluetoothInterface.

This identifier is unique for each bluetooth remote device and bluetooth interface in the system.

Returns:
the Universal Bluetooth Identifier of the current bluetooth interface

Implemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::unregisterAgent ( const QString &   )  [pure virtual]


The documentation for this class was generated from the following files:
  • ifaces/bluetoothinterface.h
  • ifaces/bluetoothinterface.cpp

libsolidcontrol

Skip menu "libsolidcontrol"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal