TableModel.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * Copyright (C) 2012-2022  Florian Pose <fp@igh.de>
 *                    2013  Dr. Wilhelm Hagemeister <hm@igh-essen.com>
 *
 * 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_TABLEMODEL_H
#define QTPDCOM_TABLEMODEL_H

#include "TableColumn.h"
#include "ScalarVariable.h"

#include <memory>
#include <QAbstractTableModel>
#include <QColor>
#include <QLocale>

namespace QtPdCom {

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

class QTPDCOM_PUBLIC TableModel: public QAbstractTableModel
{
        Q_OBJECT
        Q_PROPERTY(bool editing READ isEditing NOTIFY editingChanged)

    public:
        TableModel(QObject *parent = nullptr);
        ~TableModel();

        void addColumn(TableColumn *);
        void insertColumn(TableColumn *, int position);
        void removeColumn(TableColumn *);
        void clearColumns();

        bool isEditing() const;
        unsigned int getRowCapacity() const;
        bool hasVisibleRowsVariable() const;
        virtual int rowCount(const QModelIndex &) const;
        virtual int columnCount(const QModelIndex &) const;
        virtual QVariant data(const QModelIndex &, int) const;
        virtual QVariant headerData(int, Qt::Orientation, int) const;
        virtual Qt::ItemFlags flags(const QModelIndex &) const;
        virtual bool setData(const QModelIndex &, const QVariant &, int);

        bool insertRows(
                int position,
                int count = 1,
                const QModelIndex &parent = {}) override;
        bool removeRows(
                int row,
                int count,
                const QModelIndex &parent = {}) override;

        void setHighlightRowVariable(
                PdCom::Variable,              
                const PdCom::Selector & = {}, 
                const Transmission & =
                        QtPdCom::event_mode 
        );
        void setHighlightRowVariable(
                PdCom::Process *,             
                const QString &,              
                const PdCom::Selector & = {}, 
                const Transmission & =
                        QtPdCom::event_mode 
        );

        void clearHighlightRowVariable();

        Q_INVOKABLE QString toCsv(
                bool includeHeader,
                QChar seperator = QChar(','),
                const QLocale &locale = QLocale::c()) const;
        Q_INVOKABLE int fromCsv(
                QString csvData,
                QChar seperator = QChar(','),
                int startRow = 0,
                int startColumn = 0,
                const QLocale &locale = QLocale::c());

        void setVisibleRowsVariable(
                PdCom::Variable pv,           
                const PdCom::Selector & = {}, 
                const Transmission & =
                        QtPdCom::event_mode 
        );

        void setVisibleRowsVariable(
                PdCom::Process *,             
                const QString &,              
                const PdCom::Selector & = {}, 
                const Transmission & =
                        QtPdCom::event_mode 
        );

        void clearVisibleRowsVariable();

        void setHighlightColor(QColor, int = -1);
        void setDisabledColor(QColor, int = -1);

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

        QHash<int, QByteArray> roleNames() const override; //rolenames in TableColumn!

    signals:
        void editingChanged(bool);

    public slots:
        void commit();
        void revert();  // virtual from AbstractItemModel
        void addRow();
        void addRowAndCopyLast(); //vor intialization of the new row

        void remRow();  // not to be mixed up with the removeRow()
                        // function from AbstractItemModel

    private:
        class Q_DECL_HIDDEN Impl;

        std::unique_ptr<Impl> impl;

    private slots:
        void dimensionChanged();
        void columnHeaderChanged();
        void valueChanged();
        void highlightRowChanged();
        void visibleRowCountChanged();
};

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

}  // namespace QtPdCom

#endif