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

libsolidcontrol

Solid::Control::Ifaces::BluetoothInterface

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

#include <bluetoothinterface.h>

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

Inheritance graph
[legend]

List of all members.


Detailed Description

Represents a bluetooth interface as seen by the bluetooth subsystem.

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


Public Slots

virtual void cancelDiscovery ()=0
virtual QObject * createBluetoothRemoteDevice (const QString &address)=0
virtual void discoverDevices ()=0
virtual void discoverDevicesWithoutNameResolving ()=0
virtual void removeTrust (const QString &)=0
virtual void setDiscoverableTimeout (int timeout)=0
virtual void setMinorClass (const QString &minor)=0
virtual void setMode (const Solid::Control::BluetoothInterface::Mode mode)=0
virtual void setName (const QString &name)=0
virtual void setPeriodicDiscoveryNameResolving (bool resolveNames)=0
virtual void setTrusted (const QString &)=0
virtual void startPeriodicDiscovery ()=0
virtual void stopPeriodicDiscovery ()=0

Signals

void bondingCreated (const QString &address)
void bondingRemoved (const QString &address)
void discoverableTimeoutChanged (int timeout)
void discoveryCompleted ()
void discoveryStarted ()
void minorClassChanged (const QString &minor)
void modeChanged (Solid::Control::BluetoothInterface::Mode)
void nameChanged (const QString &name)
void remoteDeviceConnected (const QString &address)
void remoteDeviceDisappeared (const QString &ubi)
void remoteDeviceDisconnected (const QString &address)
void remoteDeviceFound (const QString &ubi, int deviceClass, int rssi)
void remoteNameUpdated (const QString &address, const QString &name)
void trustAdded (const QString &address)
void trustRemoved (const QString &address)

Public Member Functions

virtual QString address () const =0
 BluetoothInterface (QObject *parent=0)
virtual QString company () const =0
virtual int discoverableTimeout () const =0
virtual QString getRemoteName (const QString &mac)=0
virtual bool isDiscoverable () const =0
virtual bool isPeriodicDiscoveryActive () const =0
virtual bool isPeriodicDiscoveryNameResolvingActive () const =0
virtual bool isTrusted (const QString &)=0
virtual QStringList listAvailableMinorClasses () const =0
virtual QStringList listBondings () const =0
virtual QStringList listConnections () const =0
virtual QStringList listRecentRemoteDevices (const QDateTime &date) const =0
virtual QStringList listRemoteDevices () const =0
virtual QString majorClass () const =0
virtual QString manufacturer () const =0
virtual QString minorClass () const =0
virtual
Solid::Control::BluetoothInterface::Mode 
mode () const =0
virtual QString name () const =0
virtual QString revision () const =0
virtual QStringList serviceClasses () const =0
virtual QString ubi () const =0
virtual QString version () const =0
virtual ~BluetoothInterface ()

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 QString Solid::Control::Ifaces::BluetoothInterface::address (  )  const [pure virtual]

Retrieves the MAC address of the bluetooth interface/adapter.

Returns:
MAC address of bluetooth interface

Implemented in FakeBluetoothInterface.

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

This signal is emitted if a successful bonding has been created.

Parameters:
address the address of the bluetooth remote device

Reimplemented in FakeBluetoothInterface.

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

This signal is emitted if the bonding to a bluetooth device has been removed.

Parameters:
address the address of the bluetooth remote device

Reimplemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::cancelDiscovery (  )  [pure virtual, slot]

Cancel discovery of remote bluetooth devices.

Implemented in FakeBluetoothInterface.

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

Retrieves the name of the bluetooth chip company.

Based on device address.

Returns:
company string of bluetooth interface/adapter

Implemented in FakeBluetoothInterface.

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

Instantiates a new BluetoothRemoteDevice object from this backend given its address.

Parameters:
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 int Solid::Control::Ifaces::BluetoothInterface::discoverableTimeout (  )  const [pure virtual]

Retrieves the discoverable timeout of the bluetooth interface/adapter.

Discoverable timeout of 0 means never disappear.

Returns:
current discoverable timeout in seconds

Implemented in FakeBluetoothInterface.

void Solid::Control::Ifaces::BluetoothInterface::discoverableTimeoutChanged ( int  timeout  )  [signal]

The signal is emitted if the discoverable timeout of the bluetooth interface/adapter has changed.

Parameters:
timeout the changed timeout in seconds

Reimplemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::discoverDevices (  )  [pure virtual, slot]

Start discovery of remote bluetooth devices with device name resolving.

Implemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::discoverDevicesWithoutNameResolving (  )  [pure virtual, slot]

Start discovery of remote bluetooth devices without device name resolving.

Implemented in FakeBluetoothInterface.

void Solid::Control::Ifaces::BluetoothInterface::discoveryCompleted (  )  [signal]

This signal is emitted if a discovery has completed.

Reimplemented in FakeBluetoothInterface.

void Solid::Control::Ifaces::BluetoothInterface::discoveryStarted (  )  [signal]

This signal is emitted if a discovery has started.

Reimplemented in FakeBluetoothInterface.

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

Returns the name of the remote device, given its mac address (mac).

Returns:
the name of the remote device

Implemented in FakeBluetoothInterface.

virtual bool Solid::Control::Ifaces::BluetoothInterface::isDiscoverable (  )  const [pure virtual]

Retrieves the current discoverable staut of the bluetooth interface/adapter.

Returns:
current discoverable status of bluetooth interface/adapter

Implemented in FakeBluetoothInterface.

virtual bool Solid::Control::Ifaces::BluetoothInterface::isPeriodicDiscoveryActive (  )  const [pure virtual]

Periodic discovery status of this bluetooth interface/adapter.

Returns:
true if periodic discovery is already active otherwise false

Implemented in FakeBluetoothInterface.

virtual bool Solid::Control::Ifaces::BluetoothInterface::isPeriodicDiscoveryNameResolvingActive (  )  const [pure virtual]

Name resolving status of periodic discovery routing.

Returns:
true if name got resolved while periodic discovery of this bluetooth interface/adapter

Implemented in FakeBluetoothInterface.

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

Returns true if the remote bluetooth device is trusted otherwise false.

Parameters:
mac the address of the remote device

Implemented in FakeBluetoothInterface.

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

List supported minor classes of the bluetooth interface/adapter.

Returns:
list of supported minor classes by bluetooth interface/adapter

Implemented in FakeBluetoothInterface.

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

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

Returns:
UBIs of bonded/paired bluetooth remote devices

Implemented in FakeBluetoothInterface.

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

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

Returns:
list UBIs of connected bluetooth remote devices

Implemented in FakeBluetoothInterface.

virtual QStringList Solid::Control::Ifaces::BluetoothInterface::listRecentRemoteDevices ( const QDateTime &  date  )  const [pure virtual]

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

Implemented in FakeBluetoothInterface.

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

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

Implemented in FakeBluetoothInterface.

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

Retrieves major class of the bluetooth interface/adapter.

Returns:
current major class of the bluetooth interface/adapter

Implemented in FakeBluetoothInterface.

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

Retrieves the name of the bluetooth chip manufacturer.

Example: "Cambdirge Silicon Radio"

Returns:
manufacturer string of bluetooth interface/adapter

Implemented in FakeBluetoothInterface.

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

Retrievies minor class of the bluetooth interface/adapter.

Valid classes, see listAvailableMinorClasses()

Returns:
minor class of the bluetooth interface/adapter.

Implemented in FakeBluetoothInterface.

void Solid::Control::Ifaces::BluetoothInterface::minorClassChanged ( const QString &  minor  )  [signal]

The signal is emitted if the minor class of the bluetooth interface/adapter has changed.

Parameters:
minor the new minor class

Reimplemented in FakeBluetoothInterface.

virtual Solid::Control::BluetoothInterface::Mode Solid::Control::Ifaces::BluetoothInterface::mode (  )  const [pure virtual]

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

Implemented in FakeBluetoothInterface.

void Solid::Control::Ifaces::BluetoothInterface::modeChanged ( Solid::Control::BluetoothInterface::Mode   )  [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

Reimplemented in FakeBluetoothInterface.

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

Retrieves name of bluetooth interface/adapter.

Returns:
name of bluetooth interface/adapter

Implemented in FakeBluetoothInterface.

void Solid::Control::Ifaces::BluetoothInterface::nameChanged ( const QString &  name  )  [signal]

The signal is emitted if the name of the bluetooth interface/adapter has changed.

Parameters:
name the new name of the device

Reimplemented in FakeBluetoothInterface.

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

This signal is emitted if a bluetooth connection has been created.

Parameters:
address the address of the connected bluetooth remote device

Reimplemented in FakeBluetoothInterface.

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

This signal is emitted if the bluetooth interface/adapter detectes a bluetooth device disappeared.

Parameters:
ubi the ubi of the disappering bluetooth remote device

Reimplemented in FakeBluetoothInterface.

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

This signal is emitted if a bluetooth connection has been terminated.

Parameters:
address the address of the disconnected bluetooth remote device

Reimplemented in FakeBluetoothInterface.

void Solid::Control::Ifaces::BluetoothInterface::remoteDeviceFound ( const QString &  ubi,
int  deviceClass,
int  rssi 
) [signal]

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

Reimplemented in FakeBluetoothInterface.

void Solid::Control::Ifaces::BluetoothInterface::remoteNameUpdated ( const QString &  address,
const QString &  name 
) [signal]

This signal is emitted if the bluetooth interface/adapter detectes a new name for a bluetooth device.

Parameters:
address the address of the bluetooth remote device
name the name of the bluetooth remote device

Reimplemented in FakeBluetoothInterface.

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

Marks the device as not trusted.

Parameters:
mac the address of the remote device

Implemented in FakeBluetoothInterface.

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

Retrieves the revision of the chip of the bluetooth interface/adapter.

Example: "HCI 19.2"

Returns:
bluetooth chip revision

Implemented in FakeBluetoothInterface.

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

List services class of the bluetooth interface/adapter.

Returns:
list of service classes or empty list if no services registered

Implemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::setDiscoverableTimeout ( int  timeout  )  [pure virtual, slot]

Set discoverable timeout of bluetooth interface/adapter.

Parameters:
timeout timeout in seconds

Implemented in FakeBluetoothInterface.

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

Set minor class of bluetooth interface/adapter.

Parameters:
minor set minor class. Valid mode see listAvaliableMinorClasses()

Implemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::setMode ( const Solid::Control::BluetoothInterface::Mode  mode  )  [pure virtual, slot]

Set mode of bluetooth interface/adapter.

Valid modes, see mode()

Parameters:
mode the mode of the bluetooth interface/adapter

Implemented in FakeBluetoothInterface.

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

Set name of bluetooth interface/adapter.

Parameters:
name the name of bluetooth interface/adapter

Implemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::setPeriodicDiscoveryNameResolving ( bool  resolveNames  )  [pure virtual, slot]

Enable/Disable name resolving of remote bluetooth devices in periodic discovery.

Parameters:
resolveName true to enable name resolving otherwise false

Implemented in FakeBluetoothInterface.

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

Marks the device as trusted.

Parameters:
mac the address of the remote device

Implemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::startPeriodicDiscovery (  )  [pure virtual, slot]

Start periodic discovery of remote bluetooth devices.

See stopPeriodicDiscovery()

Implemented in FakeBluetoothInterface.

virtual void Solid::Control::Ifaces::BluetoothInterface::stopPeriodicDiscovery (  )  [pure virtual, slot]

Stop periodic discovery of remote bluetooth devices.

Implemented in FakeBluetoothInterface.

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

This signal is emitted if a bluetooth device was set trusted.

Parameters:
address the address of the trusted bluetooth remote device

Reimplemented in FakeBluetoothInterface.

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

This signal is emitted if the trust to the bluetooth device was removed.

Parameters:
address the address of the bluetooth remote device

Reimplemented in FakeBluetoothInterface.

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 QString Solid::Control::Ifaces::BluetoothInterface::version (  )  const [pure virtual]

Retrieves the version of the chip of the bluetooth interface/adapter.

Example: "Bluetooth 2.0 + EDR"

Returns:
bluetooth chip version

Implemented in FakeBluetoothInterface.


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
  •   libplasma
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.4
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