ObjectDescriptionData Class Reference

#include <Phonon/ObjectDescription>

Class Description

Data class for objects describing devices or features of the backend.

Author
Matthias Kretz kretz.nosp@m.@kde.nosp@m..org
See also
BackendCapabilities

Definition at line 96 of file objectdescription.h.

+ Inheritance diagram for ObjectDescriptionData:

Public Member Functions

bool operator== (const ObjectDescriptionData &otherDescription) const
 Returns true if this ObjectDescription describes the same as otherDescription; otherwise returns false. More...
 
QString name () const
 Returns the name of the capture source. More...
 
QString description () const
 Returns a description of the capture source. More...
 
QVariant property (const char *name) const
 Returns a named property. More...
 
QList< QByteArraypropertyNames () const
 Returns all names that return valid data when property() is called. More...
 
bool isValid () const
 Returns true if the Tuple is valid (index != -1); otherwise returns false. More...
 
int index () const
 A unique identifier for this device/. More...
 
 ~ObjectDescriptionData ()
 
 ObjectDescriptionData (ObjectDescriptionPrivate *=0)
 
 ObjectDescriptionData (int index, const QHash< QByteArray, QVariant > &properties)
 
- Public Member Functions inherited from QSharedData
 QSharedData ()
 
 QSharedData (const QSharedData &)
 

Static Public Member Functions

static ObjectDescriptionDatafromIndex (ObjectDescriptionType type, int index)
 

Protected Attributes

ObjectDescriptionPrivate *const d
 

Additional Inherited Members

- Public Attributes inherited from QSharedData
QAtomicInt ref
 

Constructor & Destructor Documentation

ObjectDescriptionData ( ObjectDescriptionPrivate *  = 0)
ObjectDescriptionData ( int  index,
const QHash< QByteArray, QVariant > &  properties 
)

Member Function Documentation

bool operator== ( const ObjectDescriptionData otherDescription) const

Returns true if this ObjectDescription describes the same as otherDescription; otherwise returns false.

QString name ( ) const

Returns the name of the capture source.

Returns
A string that should be presented to the user to choose the capture source.
QString description ( ) const

Returns a description of the capture source.

This text should make clear what sound source this is, which is sometimes hard to describe or understand from just the name.

Returns
A string describing the capture source.
QVariant property ( const char *  name) const

Returns a named property.

If the property is not set an invalid value is returned.

See also
propertyNames()
QList<QByteArray> propertyNames ( ) const

Returns all names that return valid data when property() is called.

See also
property()
bool isValid ( ) const

Returns true if the Tuple is valid (index != -1); otherwise returns false.

int index ( ) const

A unique identifier for this device/.

Used internally to distinguish between the devices/.

Returns
An integer that uniquely identifies every device/
static ObjectDescriptionData* fromIndex ( ObjectDescriptionType  type,
int  index 
)
static

Member Data Documentation

ObjectDescriptionPrivate* const d
protected

Definition at line 160 of file objectdescription.h.


The documentation for this class was generated from the following file: