Phonon::ObjectDescription< T > Class Template Reference

#include <phonon/ObjectDescription>

Public Member Functions
	ObjectDescription (int index, const QHash< QByteArray, QVariant > &properties)
QString	description () const
int	index () const
bool	isValid () const
QString	name () const
bool	operator!= (const ObjectDescription &otherDescription) const
bool	operator== (const ObjectDescription &otherDescription) const
QVariant	property (const char *name) const
QList< QByteArray >	propertyNames () const

Static Public Member Functions
static ObjectDescription< T >	fromIndex (int index)

Protected Member Functions
	ObjectDescription (const QExplicitlySharedDataPointer< ObjectDescriptionData > &dd)

Protected Attributes
QExplicitlySharedDataPointer< ObjectDescriptionData >	d

Detailed Description

template<ObjectDescriptionType T>
class Phonon::ObjectDescription< T >

Provides a tuple of enduser visible name and description.

Some parts give the enduser choices, e.g. what source to capture audio from. These choices are described by the name and description methods of this class and identified with the id method. Subclasses then define additional information like which audio and video choices belong together.

Author

Matthias Kretz kretz.nosp@m.@kde.nosp@m..org

Definition at line 182 of file objectdescription.h.

Constructor & Destructor Documentation

ObjectDescription() [1/3]

template<ObjectDescriptionType T>

Phonon::ObjectDescription< T >::ObjectDescription ( )

inline

Definition at line 256 of file objectdescription.h.

ObjectDescription() [2/3]

template<ObjectDescriptionType T>

Phonon::ObjectDescription< T >::ObjectDescription ( int index, const QHash< QByteArray, QVariant > & properties )

inline

Definition at line 257 of file objectdescription.h.

ObjectDescription() [3/3]

template<ObjectDescriptionType T>

Phonon::ObjectDescription< T >::ObjectDescription ( const QExplicitlySharedDataPointer< ObjectDescriptionData > & dd )

inlineprotected

Definition at line 261 of file objectdescription.h.

Member Function Documentation

description()

template<ObjectDescriptionType T>

QString Phonon::ObjectDescription< T >::description ( ) const

inline

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.

Definition at line 224 of file objectdescription.h.

fromIndex()

template<ObjectDescriptionType T>

static ObjectDescription< T > Phonon::ObjectDescription< T >::fromIndex ( int index )

inlinestatic

Returns a new description object that describes the device/effect/codec/... with the given index.

Definition at line 189 of file objectdescription.h.

index()

template<ObjectDescriptionType T>

int Phonon::ObjectDescription< T >::index ( ) const

inline

A unique identifier for this device/.

Used internally to distinguish between the devices/.

Returns

An integer that uniquely identifies every device/

Definition at line 254 of file objectdescription.h.

isValid()

template<ObjectDescriptionType T>

bool Phonon::ObjectDescription< T >::isValid ( ) const

inline

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

Definition at line 246 of file objectdescription.h.

name()

template<ObjectDescriptionType T>

QString Phonon::ObjectDescription< T >::name ( ) const

inline

Returns the name of the capture source.

Returns

A string that should be presented to the user to choose the capture source.

Definition at line 215 of file objectdescription.h.

operator!=()

template<ObjectDescriptionType T>

bool Phonon::ObjectDescription< T >::operator!= ( const ObjectDescription< T > & otherDescription ) const

inline

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

Definition at line 205 of file objectdescription.h.

operator==()

template<ObjectDescriptionType T>

bool Phonon::ObjectDescription< T >::operator== ( const ObjectDescription< T > & otherDescription ) const

inline

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

Definition at line 197 of file objectdescription.h.

property()

template<ObjectDescriptionType T>

QVariant Phonon::ObjectDescription< T >::property ( const char * name ) const

inline

Returns a named property.

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

See also

propertyNames()

Definition at line 233 of file objectdescription.h.

propertyNames()

template<ObjectDescriptionType T>

QList< QByteArray > Phonon::ObjectDescription< T >::propertyNames ( ) const

inline

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

See also

property()

Definition at line 240 of file objectdescription.h.

Member Data Documentation

d

template<ObjectDescriptionType T>

QExplicitlySharedDataPointer<ObjectDescriptionData> Phonon::ObjectDescription< T >::d

protected

Definition at line 262 of file objectdescription.h.

---

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

• objectdescription.h