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

Solid

Solid::GenericInterface

Solid::GenericInterface Class Reference

Generic interface to deal with a device. More...

#include <genericinterface.h>

Inheritance diagram for Solid::GenericInterface:
Solid::DeviceInterface QObject

List of all members.

Public Types

enum  PropertyChange { PropertyModified, PropertyAdded, PropertyRemoved }

Signals

void conditionRaised (const QString &condition, const QString &reason)
void propertyChanged (const QMap< QString, int > &changes)

Public Member Functions

QMap< QString, QVariant > allProperties () const
QVariant property (const QString &key) const
bool propertyExists (const QString &key) const
virtual ~GenericInterface ()

Static Public Member Functions

static Type deviceInterfaceType ()

Detailed Description

Generic interface to deal with a device.

It exposes a set of properties and is organized a a key/value set.

Warning: Using this class could expose some backend specific details and lead to non portable code. Use it at your own risk, or during transitional phases when the provided device interfaces don't provide the necessary methods.

Definition at line 43 of file genericinterface.h.


Member Enumeration Documentation

enum Solid::GenericInterface::PropertyChange

This enum type defines the type of change that can occur to a GenericInterface property.

  • PropertyModified : A property value has changed in the device
  • PropertyAdded : A new property has been added to the device
  • PropertyRemoved : A property has been removed from the device
Enumerator:
PropertyModified 
PropertyAdded 
PropertyRemoved 

Definition at line 59 of file genericinterface.h.


Constructor & Destructor Documentation

Solid::GenericInterface::~GenericInterface (  )  [virtual]

Destroys a Processor object.

Definition at line 39 of file genericinterface.cpp.


Member Function Documentation

QMap< QString, QVariant > Solid::GenericInterface::allProperties (  )  const

Retrieves a key/value map of all the known properties for the device.

Warning: Using this method could expose some backend specific details and lead to non portable code. Use it at your own risk, or during transitional phases when the provided device interfaces don't provide the necessary methods.

Returns:
all the properties of the device

Definition at line 50 of file genericinterface.cpp.

void Solid::GenericInterface::conditionRaised ( const QString &  condition,
const QString &  reason 
) [signal]

This signal is emitted when an event occurred in the device.

For example when a button is pressed.

Parameters:
condition the condition name
reason a message explaining why the condition has been raised
static Type Solid::GenericInterface::deviceInterfaceType (  )  [inline, static]

Get the Solid::DeviceInterface::Type of the GenericInterface device interface.

Returns:
the Processor device interface type
See also:
Solid::Ifaces::Enums::DeviceInterface::Type

Definition at line 85 of file genericinterface.h.

QVariant Solid::GenericInterface::property ( const QString &  key  )  const

Retrieves a property of the device.

Warning: Using this method could expose some backend specific details and lead to non portable code. Use it at your own risk, or during transitional phases when the provided device interfaces don't provide the necessary methods.

Parameters:
key the property key
Returns:
the actual value of the property, or QVariant() if the property is unknown

Definition at line 44 of file genericinterface.cpp.

void Solid::GenericInterface::propertyChanged ( const QMap< QString, int > &  changes  )  [signal]

This signal is emitted when a property is changed in the device.

Parameters:
changes the map describing the property changes that occurred in the device, keys are property name and values describe the kind of change done on the device property (added/removed/modified), it's one of the type Solid::Device::PropertyChange
bool Solid::GenericInterface::propertyExists ( const QString &  key  )  const

Tests if a property exist in the device.

Warning: Using this method could expose some backend specific details and lead to non portable code. Use it at your own risk, or during transitional phases when the provided device interfaces don't provide the necessary methods.

Parameters:
key the property key
Returns:
true if the property is available in the device, false otherwise

Definition at line 56 of file genericinterface.cpp.


The documentation for this class was generated from the following files:
  • genericinterface.h
  • genericinterface.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