Sentence.h

/*
 * Foreign Language Trainer is a program to study foreign languages through
 * various exercises.
 *
 * Copyright (C) 2019 Sergey Kovalev
 * https://github.com/skvl/flt

 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
#ifndef SENTENCE_H
#define SENTENCE_H

#include <QAbstractListModel>
#include "Word.h"

/*
 * Represents sentence in exercise.
 *
 * Each sentence gives un-ordered list of words which user could re-order.
 * In addition sentence gives interface to check if the order is correct.
 */
class Sentence : public QAbstractListModel
{
    Q_OBJECT

    Q_PROPERTY(QString audio READ audio CONSTANT)
    Q_PROPERTY(QString translation READ translation CONSTANT)
    Q_PROPERTY(QString origin READ origin CONSTANT)
    Q_PROPERTY(QString result READ result CONSTANT)

public:
    using Translations = QMap<QString, QString>;

    enum Roles {
        DataRole = Qt::UserRole + 1,
        BackgroundRole,
        ForegroundRole,
    };

    explicit Sentence(QString audio = QString(),
                      QVector<Word> sentence = QVector<Word>(),
                      Translations translations = Translations(),
                      QObject *parent = nullptr);

    int rowCount(const QModelIndex &parent = QModelIndex()) const;
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
    Q_INVOKABLE void move(int from, int to);

    QString audio() const;
    QString translation() const;

    bool wrong() const;
    QString origin() const;
    QString result() const;

protected:
    QHash<int, QByteArray> roleNames() const;

private:
    QString m_audio;
    QVector<Word> m_sentence;
    Translations m_translations;
    QString m_origin;
};

#endif // SENTENCE_H