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

Solid

Solid::Device

Solid::Device Class Reference

This class allows applications to deal with devices available in the underlying system. More...

#include <device.h>

List of all members.

Public Member Functions

template<class DevIface >
const DevIface * as () const
template<class DevIface >
DevIface * as ()
const DeviceInterface * asDeviceInterface (const DeviceInterface::Type &type) const
DeviceInterface * asDeviceInterface (const DeviceInterface::Type &type)
 Device (const Device &device)
 Device (const QString &udi=QString())
QString icon () const
template<class DevIface >
bool is () const
bool isDeviceInterface (const DeviceInterface::Type &type) const
bool isValid () const
Device & operator= (const Device &device)
Device parent () const
QString parentUdi () const
QString product () const
QString udi () const
QString vendor () const
 ~Device ()

Static Public Member Functions

static QList< Device > allDevices ()
static QList< Device > listFromQuery (const QString &predicate, const QString &parentUdi=QString())
static QList< Device > listFromQuery (const Predicate &predicate, const QString &parentUdi=QString())
static QList< Device > listFromType (const DeviceInterface::Type &type, const QString &parentUdi=QString())

Detailed Description

This class allows applications to deal with devices available in the underlying system.

Device stores a reference to device data provided by the backend. Device objects are designed to be used by value. Copying these objects is quite cheap, so using pointers to the me is generally not needed.

Author:
Kevin Ottens <ervin@kde.org>

Definition at line 47 of file device.h.


Constructor & Destructor Documentation

Solid::Device::Device ( const QString &  udi = QString()  )  [explicit]

Constructs a device for a given Universal Device Identifier (UDI).

Parameters:
udi the udi of the device to create

Definition at line 70 of file device.cpp.

Solid::Device::Device ( const Device &  device  ) 

Constructs a copy of a device.

Parameters:
device the device to copy

Definition at line 77 of file device.cpp.

Solid::Device::~Device (  ) 

Destroys the device.

Definition at line 82 of file device.cpp.


Member Function Documentation

QList< Solid::Device > Solid::Device::allDevices (  )  [static]

Retrieves all the devices available in the underlying system.

Returns:
the list of the devices available

Definition at line 56 of file devicemanager.cpp.

template<class DevIface >
const DevIface* Solid::Device::as (  )  const [inline]

Retrieves a specialized interface to interact with the device corresponding to a given device interface.

Returns:
a pointer to the device interface if it exists, 0 otherwise

Definition at line 234 of file device.h.

template<class DevIface >
DevIface* Solid::Device::as (  )  [inline]

Retrieves a specialized interface to interact with the device corresponding to a given device interface.

Returns:
a pointer to the device interface if it exists, 0 otherwise

Definition at line 221 of file device.h.

const Solid::DeviceInterface * Solid::Device::asDeviceInterface ( const DeviceInterface::Type &  type  )  const

Retrieves a specialized interface to interact with the device corresponding to a particular device interface.

Parameters:
type the device interface type
Returns:
a pointer to the device interface interface if it exists, 0 otherwise

Definition at line 150 of file device.cpp.

Solid::DeviceInterface * Solid::Device::asDeviceInterface ( const DeviceInterface::Type &  type  ) 

Retrieves a specialized interface to interact with the device corresponding to a particular device interface.

Parameters:
type the device interface type
Returns:
a pointer to the device interface interface if it exists, 0 otherwise

Definition at line 144 of file device.cpp.

QString Solid::Device::icon (  )  const

Retrieves the name of the icon representing this device.

The naming follows the freedesktop.org specification.

Returns:
the icon name

Definition at line 131 of file device.cpp.

template<class DevIface >
bool Solid::Device::is (  )  const [inline]

Tests if a device provides a given device interface.

Returns:
true if the interface is available, false otherwise

Definition at line 246 of file device.h.

bool Solid::Device::isDeviceInterface ( const DeviceInterface::Type &  type  )  const

Tests if a device interface is available from the device.

Parameters:
type the device interface type to query
Returns:
true if the device interface is available, false otherwise

Definition at line 136 of file device.cpp.

bool Solid::Device::isValid (  )  const

Indicates if this device is valid.

A device is considered valid if it's available in the system.

Returns:
true if this device is available, false otherwise

Definition at line 92 of file device.cpp.

QList< Solid::Device > Solid::Device::listFromQuery ( const QString &  predicate,
const QString &  parentUdi = QString() 
) [static]

Convenience function see above.

Parameters:
predicate 
parentUdi 
Returns:
the list of devices

Definition at line 74 of file devicemanager.cpp.

QList< Solid::Device > Solid::Device::listFromQuery ( const Predicate &  predicate,
const QString &  parentUdi = QString() 
) [static]

Retrieves a list of devices of the system given matching the given constraints (parent and predicate).

Parameters:
predicate Predicate that the devices we're searching for must verify
parentUdi UDI of the parent of the devices we're searching for, or QString() if there's no constraint on the parent
Returns:
the list of devices corresponding to the given constraints
See also:
Solid::Predicate

Definition at line 109 of file devicemanager.cpp.

QList< Solid::Device > Solid::Device::listFromType ( const DeviceInterface::Type &  type,
const QString &  parentUdi = QString() 
) [static]

Retrieves a list of devices of the system given matching the given constraints (parent and device interface type).

Parameters:
type device interface type available on the devices we're looking for, or DeviceInterface::Unknown if there's no constraint on the device interfaces
parentUdi UDI of the parent of the devices we're searching for, or QString() if there's no constraint on the parent
Returns:
the list of devices corresponding to the given constraints
See also:
Solid::Predicate

Definition at line 89 of file devicemanager.cpp.

Solid::Device & Solid::Device::operator= ( const Device &  device  ) 

Assigns a device to this device and returns a reference to it.

Parameters:
device the device to assign
Returns:
a reference to the device

Definition at line 86 of file device.cpp.

Solid::Device Solid::Device::parent (  )  const

Retrieves the parent of the Device.

Returns:
the device's parent
See also:
parentUdi()

Definition at line 107 of file device.cpp.

QString Solid::Device::parentUdi (  )  const

Retrieves the Universal Device Identifier (UDI) of the Device's parent.

Returns:
the udi of the device's parent

Definition at line 102 of file device.cpp.

QString Solid::Device::product (  )  const

Retrieves the name of the product corresponding to this device.

Returns:
the product name

Definition at line 126 of file device.cpp.

QString Solid::Device::udi (  )  const

Retrieves the Universal Device Identifier (UDI).

Warning:
Don't use the UDI for anything except communication with Solid. Also don't store UDIs as there's no guarantee that the UDI stays the same when the hardware setup changed. The UDI is a unique identifier that is local to the computer in question and for the current boot session. The UDIs may change after a reboot. Similar hardware in other computers may have different values; different hardware could have the same UDI.
Returns:
the udi of the device

Definition at line 97 of file device.cpp.

QString Solid::Device::vendor (  )  const

Retrieves the name of the device vendor.

Returns:
the vendor name

Definition at line 121 of file device.cpp.


The documentation for this class was generated from the following files:
  • device.h
  • device.cpp
  • devicemanager.cpp

Solid

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
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