aboutsummaryrefslogtreecommitdiff
path: root/src/qmmp/metadatamodel.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/qmmp/metadatamodel.h')
-rw-r--r--src/qmmp/metadatamodel.h29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/qmmp/metadatamodel.h b/src/qmmp/metadatamodel.h
index d787fe5e1..f95797b8e 100644
--- a/src/qmmp/metadatamodel.h
+++ b/src/qmmp/metadatamodel.h
@@ -28,16 +28,45 @@
#include <QPixmap>
#include "tagmodel.h"
+/*! @brief The MetaDataModel is the base interface class of metadata access.
+ * @author Ilya Kotov <forkotov02@hotmail.ru>
+ */
class MetaDataModel : public QObject
{
Q_OBJECT
public:
+ /*!
+ * Constructor.
+ * @param parent Parent Object.
+ */
MetaDataModel(QObject *parent = 0);
+ /*!
+ * Destructor.
+ */
virtual ~MetaDataModel();
+ /*!
+ * Returns an associative array of the audio properties.
+ * Subclass should reimplement this function. Default implementation returns empty array.
+ */
virtual QHash<QString, QString> audioProperties();
+ /*!
+ * Returns an associative array of the long descriptions.
+ * Subclass should reimplement this function. Default implementation returns empty array.
+ */
virtual QHash<QString, QString> descriptions();
+ /*!
+ * Returns a list of available tags.
+ * Subclass should reimplement this function. Default implementation returns empty array.
+ */
virtual QList<TagModel* > tags();
+ /*!
+ * Returns cover pixmap.
+ * Subclass should reimplement this function. Default implementation returns empty pixmap.
+ */
virtual QPixmap cover();
+ /*!
+ * Returns path to cover pixmap.
+ */
virtual QString coverPath();
};