Phonon: Phonon::ObjectDescription< T > Class Template Reference

Phonon 4.7.0

•All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages

Phonon
ObjectDescription

Provides a tuple of enduser visible name and description. More...

#include <phonon/ObjectDescription>

Public Member Functions
bool	operator== (const ObjectDescription &otherDescription) const

bool	operator!= (const ObjectDescription &otherDescription) const

QString	name () const

QString	description () const

QVariant	property (const char *name) const

QList< QByteArray >	propertyNames () const

bool	isValid () const

int	index () const

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

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

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

Protected Attributes
QExplicitlySharedDataPointer < ObjectDescriptionData >	d

Friends
class	ObjectDescriptionModel< T >

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

Member Function Documentation

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.

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.

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/

template<ObjectDescriptionType T>

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

inline

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

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.

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.

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.

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()

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()

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

/home/me/src/git/p/phonon/phonon/objectdescription.h