metadatamodel.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2009-2024 by Ilya Kotov                                 *
 *   forkotov02@ya.ru                                                      *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
 ***************************************************************************/

#ifndef METADATAMODEL_H
#define METADATAMODEL_H

#include <QCoreApplication>
#include <QPixmap>
#include <QVariant>
#include <QFlags>
#include "tagmodel.h"
#include "regularexpression.h"

class QMMP_EXPORT MetaDataItem
{
public:
    MetaDataItem(const QString &name, const QVariant &value, const QString &suffix = QString());
    const QString &name() const;
    void setName(const QString &name);
    const QVariant &value() const;
    void setValue(const QString &value);
    const QString &suffix() const;
    void setSuffix(const QString &suffix);

private:
    QString m_name, m_suffix;
    QVariant m_value;

};

class QMMP_EXPORT MetaDataModel
{
public:
    enum DialogHint
    {
        IsCoverEditable = 0x1,      
        CompletePropertyList = 0x2, 
        IsCueEditable = 0x4         
    };
    Q_DECLARE_FLAGS(DialogHints, DialogHint)

    
    explicit MetaDataModel(bool readOnly, DialogHints hints = DialogHints());
    virtual ~MetaDataModel() = default;

    virtual QList<MetaDataItem> extraProperties() const;
    virtual QList<MetaDataItem> descriptions() const;
    virtual QList<TagModel*> tags() const;
    virtual QPixmap cover() const;
    virtual void setCover(const QPixmap &pix);
    virtual void removeCover();
    virtual QString coverPath() const;
    virtual QString cue() const;
    virtual void setCue(const QString &content);
    virtual void removeCue();
    virtual QString lyrics() const;
    bool isReadOnly() const;
    const DialogHints &dialogHints() const;

protected:
    void setDialogHints(const DialogHints &hints);
    void setReadOnly(bool readOnly);

private:
    bool m_readOnly;
    DialogHints m_dialogHints;

};

Q_DECLARE_OPERATORS_FOR_FLAGS(MetaDataModel::DialogHints)

#endif