MessageModel.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * Copyright (C) 2009 - 2022  Florian Pose <fp@igh.de>
 *
 * This file is part of the QtPdCom library.
 *
 * The QtPdCom library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * The QtPdCom library 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 Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the QtPdCom Library. If not, see <http://www.gnu.org/licenses/>.
 *
 ****************************************************************************/

#ifndef QTPDCOM_MESSAGEMODEL_H
#define QTPDCOM_MESSAGEMODEL_H

#include "Message.h"

#include <QAbstractTableModel>
#include <QIcon>

#include <memory>

namespace QtPdCom {

class Process;

/****************************************************************************/

class QTPDCOM_PUBLIC MessageModel: public QAbstractTableModel
{
        Q_OBJECT
        Q_PROPERTY(int rowLimit READ getRowLimit WRITE setRowLimit)
        Q_PROPERTY(QtPdCom::Process *process READ getProcess WRITE connect)
        Q_PROPERTY(QVariantMap iconPaths READ getIconPathMap WRITE
                           setIconPathMap)

        friend class Message::Impl;

    public:
        enum Columns {
            TextColumn = 0,
            TimeOccurredColumn,
            TimeResetColumn,
        };
        Q_ENUM(Columns)

        MessageModel(QObject *parent = nullptr);
        ~MessageModel();

        Q_INVOKABLE void
        load(const QString &path,
             const QString &lang = QString(),
             const QString &pathPrefix = QString());
        Q_INVOKABLE void clear();

        void setRowLimit(int);
        int getRowLimit() const;

        void connect(QtPdCom::Process *);
        QtPdCom::Process *getProcess() const;
        Q_INVOKABLE void translate(const QString &);

        void setIcon(Message::Type, const QIcon &);
        const QIcon &getIcon(Message::Type) const;
        Q_INVOKABLE void setIconPath(Message::Type, const QString &);

        QVariantMap getIconPathMap() const;
        void setIconPathMap(QVariantMap map);

        enum Roles {
            DecorationPathRole = Qt::UserRole + 1,
            TimeStringRole = Qt::UserRole + 2,
            ResetTimeStringRole = Qt::UserRole + 3,
            MessageTypeRole = Qt::UserRole + 4,
        };
        Q_ENUM(Roles)

        // from QAbstractItemModel
        virtual int rowCount(const QModelIndex &) const override;
        virtual int columnCount(const QModelIndex &) const override;
        virtual QVariant data(const QModelIndex &, int) const override;
        virtual QVariant headerData(int, Qt::Orientation, int) const override;
        virtual Qt::ItemFlags flags(const QModelIndex &) const override;
        virtual QHash<int, QByteArray> roleNames() const override;
        virtual bool canFetchMore(const QModelIndex &) const override;
        virtual void fetchMore(const QModelIndex &) override;

        struct Exception
        {
                Exception(const QString &msg):
                    msg(msg)
                {}
                QString msg; 
        };

    signals:
        void currentMessage(const QtPdCom::Message *message);

        void anyMessage(const QtPdCom::Message *message);

    protected:
        bool event(QEvent *) override;

    private:
        class Q_DECL_HIDDEN Impl;
        std::unique_ptr<Impl> impl;
};

/****************************************************************************/

}  // namespace QtPdCom

#endif