KDE 4.0 API Reference Phonon
ObjectDescription Class Template Reference
[Classes for applications using Phonon]
#include <Phonon/ObjectDescription>
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.
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 |
Static Public Member Functions | |
| static ObjectDescription< T > | fromIndex (int index) |
Member Function Documentation
| static ObjectDescription<T> fromIndex | ( | int | index | ) | [inline, static] |
Returns a new description object that describes the device/effect/codec/.
.. with the given index.
| bool operator== | ( | const ObjectDescription< T > & | otherDescription | ) | const [inline] |
Returns true if this ObjectDescription describes the same as otherDescription; otherwise returns false.
| bool operator!= | ( | const ObjectDescription< T > & | otherDescription | ) | const [inline] |
Returns false if this ObjectDescription describes the same as otherDescription; otherwise returns true.
| QString 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.
| QString 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.
| QVariant property | ( | const char * | name | ) | const [inline] |
Returns a named property.
If the property is not set an invalid value is returned.
- See also:
- propertyNames()
| QList<QByteArray> propertyNames | ( | ) | const [inline] |
| bool isValid | ( | ) | const [inline] |
Returns true if the Tuple is valid (index != -1); otherwise returns false.
| int index | ( | ) | const [inline] |
A unique identifier for this device/.
Used internally to distinguish between the devices/.
- Returns:
- An integer that uniquely identifies every device/
The documentation for this class was generated from the following file:
- objectdescription.h
