Phonon::ObjectDescriptionData
#include <phonon/ObjectDescription>
Public Member Functions | |
ObjectDescriptionData (int index, const QHash< QByteArray, QVariant > &properties) | |
ObjectDescriptionData (ObjectDescriptionPrivate *=nullptr) | |
QString | description () const |
int | index () const |
bool | isValid () const |
QString | name () const |
bool | operator== (const ObjectDescriptionData &otherDescription) const |
QVariant | property (const char *name) const |
QList< QByteArray > | propertyNames () const |
Public Member Functions inherited from QSharedData | |
QSharedData (const QSharedData &) | |
Static Public Member Functions | |
static ObjectDescriptionData * | fromIndex (ObjectDescriptionType type, int index) |
Protected Attributes | |
ObjectDescriptionPrivate *const | d |
Detailed Description
Data class for objects describing devices or features of the backend.
- See also
- BackendCapabilities
Definition at line 98 of file objectdescription.h.
Constructor & Destructor Documentation
◆ ~ObjectDescriptionData()
Phonon::ObjectDescriptionData::~ObjectDescriptionData | ( | ) |
Definition at line 47 of file objectdescription.cpp.
◆ ObjectDescriptionData() [1/2]
Phonon::ObjectDescriptionData::ObjectDescriptionData | ( | ObjectDescriptionPrivate * | dd = nullptr | ) |
Definition at line 42 of file objectdescription.cpp.
◆ ObjectDescriptionData() [2/2]
Phonon::ObjectDescriptionData::ObjectDescriptionData | ( | int | index, |
const QHash< QByteArray, QVariant > & | properties ) |
Definition at line 37 of file objectdescription.cpp.
Member Function Documentation
◆ description()
QString Phonon::ObjectDescriptionData::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.
Definition at line 79 of file objectdescription.cpp.
◆ fromIndex()
|
static |
Definition at line 108 of file objectdescription.cpp.
◆ index()
int Phonon::ObjectDescriptionData::index | ( | ) | const |
A unique identifier for this device/.
Used internally to distinguish between the devices/.
- Returns
- An integer that uniquely identifies every device/
Definition at line 63 of file objectdescription.cpp.
◆ isValid()
bool Phonon::ObjectDescriptionData::isValid | ( | ) | const |
Returns true
if the Tuple is valid (index != -1); otherwise returns false
.
Definition at line 103 of file objectdescription.cpp.
◆ name()
QString Phonon::ObjectDescriptionData::name | ( | ) | const |
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 71 of file objectdescription.cpp.
◆ operator==()
bool Phonon::ObjectDescriptionData::operator== | ( | const ObjectDescriptionData & | otherDescription | ) | const |
Returns true
if this ObjectDescription describes the same as otherDescription
; otherwise returns false
.
Definition at line 52 of file objectdescription.cpp.
◆ property()
QVariant Phonon::ObjectDescriptionData::property | ( | const char * | name | ) | const |
Returns a named property.
If the property is not set an invalid value is returned.
- See also
- propertyNames()
Definition at line 87 of file objectdescription.cpp.
◆ propertyNames()
QList< QByteArray > Phonon::ObjectDescriptionData::propertyNames | ( | ) | const |
Returns all names that return valid data when property() is called.
- See also
- property()
Definition at line 95 of file objectdescription.cpp.
Member Data Documentation
◆ d
|
protected |
Definition at line 162 of file objectdescription.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:29:17 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.