# class Device

###

Module | solid
Namespace | Solid
Class | Device
Inherits |

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>

### methods

- Device (udi)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  udi | QString | QString()

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

  udi - the udi of the device to create

- Device (device)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  device | Solid.Device |

  Constructs a copy of a device.

  device - the device to copy

- Device (a0)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QString | QString()

- allDevices ( )

  returns QList<Solid::Device>
  static

  Retrieves all the devices available in the underlying system.

  Returns the list of the devices available

- asDeviceInterface (type)

  returns Solid.DeviceInterface

  Argument | Type | Default
  --- | --- | ---
  type | Solid::DeviceInterface.Type |

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

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

- asDeviceInterface (type)

  returns Solid.DeviceInterface
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  type | Solid::DeviceInterface.Type |

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

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

- icon ( )

  returns QString

  Retrieves the name of the icon representing this device. The naming follows the freedesktop.org specification.

  Returns the icon name

- isDeviceInterface (type)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  type | Solid::DeviceInterface.Type |

  Tests if a device interface is available from the device.

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

- isValid ( )

  returns bool

  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

- listFromQuery (predicate, parentUdi)

  returns QList<Solid::Device>
  static

  Argument | Type | Default
  --- | --- | ---
  predicate | Solid.Predicate |
  parentUdi | QString | QString()

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

  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

- listFromQuery (predicate, parentUdi)

  returns QList<Solid::Device>
  static

  Argument | Type | Default
  --- | --- | ---
  predicate | QString |
  parentUdi | QString | QString()

  Convenience function see above.

  predicate -

  parentUdi - Returns the list of devices

- listFromType (type, parentUdi)

  returns QList<Solid::Device>
  static

  Argument | Type | Default
  --- | --- | ---
  type | Solid::DeviceInterface.Type |
  parentUdi | QString | QString()

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

  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

- parent ( )

  returns Solid.Device

  Retrieves the parent of the Device.

  Returns the device's parent

  See also parentUdi()

- parentUdi ( )

  returns QString

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

  Returns the udi of the device's parent

- product ( )

  returns QString

  Retrieves the name of the product corresponding to this device.

  Returns the product name

- udi ( )

  returns QString

  Retrieves the Universal Device Identifier (UDI).

  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

- vendor ( )

  returns QString

  Retrieves the name of the device vendor.

  Returns the vendor name