ZTableModel.h

Go to the documentation of this file.

/*
 * Zuble - A simple QML/Javascript application framework
 * Copyright (C) 2014  Bob Dinitto
 *
 * Filename:   ZTableModel.h
 * Created on: 11/9/2014
 * Author:     bob
 *
 * Zuble 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 2.1 of the License, or (at your option) any later version.
 *
 * This 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#ifndef ZTABLEMODEL_H
#define ZTABLEMODEL_H


//#include <QObject>

#include <QAbstractTableModel>
#include "ZblDataModel.h"
#include "zglobal.h"
#include <QJsonObject>
#include <QItemSelection>


namespace Zbl
{

typedef QHash<int, QByteArray> ZRoleNames;

#if 0

//typedef QMap<QString, QVariant> ZRoleNameMap;
#endif

typedef QList<QVariant> ZDataRow;

typedef QMap<int, QList<QVariant> > ZRoleRow;

typedef QList<QMap<int, QList<QVariant> > > ZRoleRowList;

typedef QList<QMap<int, QVariant> > ZTableRowList;


class ZTableModel : public QAbstractTableModel
{
    //typedef QList<QList<QVariant> > tableData;

    friend class ZblLogManager;
    //friend class ZblLogWorker;

    Q_OBJECT
public:

    explicit ZTableModel(QObject *parent = 0);

    static void registerType();

    Q_PROPERTY(int userRole READ getUserRole)

    
    Q_PROPERTY(int roleCount READ getRoleCount)

    int getUserRole();

    int getRoleCount() const;


    virtual int rowCount(const QModelIndex & parent = QModelIndex()) const;

    virtual int columnCount(const QModelIndex & parent = QModelIndex()) const;

    virtual QVariant data(
            const QModelIndex & index,
            int role = Qt::DisplayRole) const;



    virtual QHash<int, QByteArray> roleNames() const;



    // begin javascript access methods

     Q_INVOKABLE void dumpModelData() const;

    Q_INVOKABLE void putValue(int role, int row, const QVariant& value);

    Q_INVOKABLE void putValue(int role, int row, int column, const QVariant& value);

    Q_INVOKABLE QVariant getValue(int role, int row);

    Q_INVOKABLE QVariant getValue(int role, int row, int column);

    Q_INVOKABLE QVariant getTableColumnRows(
            QList<int> roles,
            int startRow,
            int col,
            int rowCount);

    Q_INVOKABLE void putTableColumnRows(
            QVariant rows,
            int startRow,
            int col);

    Q_INVOKABLE void sendTableColumnRows(
            QVariant rows,
            int startRow,
            int col);


    Q_INVOKABLE void appendRow(QVariant data);

    Q_INVOKABLE void appendRows(QVariant data);

    Q_INVOKABLE void appendRow(ZRoleRow roleRow);

    Q_INVOKABLE int appendRowIndex(ZRoleRow roleRow);

    Q_INVOKABLE void appendRows(ZRoleRowList roleRowList);

    Q_INVOKABLE void prependRow(QVariant data);

    Q_INVOKABLE void prependRows(QVariant data);

    Q_INVOKABLE void prependRow(ZRoleRow roleRow);

    Q_INVOKABLE void prependRows(ZRoleRowList roleRowList);

    Q_INVOKABLE void removeRow(int row);

    Q_INVOKABLE void removeRows(int row, int count);

    Q_INVOKABLE void truncate(int rowCount, bool removeFromFront = false);

    Q_INVOKABLE bool copyColumn(int fromColumn, int toColumn);


    Q_INVOKABLE void appendCells(QVariant data, bool truncateModel=false);

    Q_INVOKABLE void prependCells(QVariant data, bool truncateModel=false);

    Q_INVOKABLE int modelRowCount() const;

    Q_INVOKABLE void setColumnCount(int count);

    Q_INVOKABLE int modelColumnCount() const;


    Q_INVOKABLE bool addRole(int roleNumber);

    Q_INVOKABLE bool addRole(int roleNumber, const QString& roleName);

    Q_INVOKABLE QList<int> roles() const;

    Q_INVOKABLE QVariantMap roleMap() const;


    Q_INVOKABLE void clearRoles();

    Q_INVOKABLE void clearData();

    //Q_INVOKABLE QVariant findItems(const QString & text, Qt::MatchFlags flags = Qt::MatchExactly, int column = 0) const;

    //QVariant findItems(const QString & text, Qt::MatchFlags flags = Qt::MatchExactly, int column = 0) const;


    Q_INVOKABLE int findNextItemRow(
            int startRow,
            const QString& text,
            int column = 0,
            bool caseSensitive = true,
            bool forwardDirection = true,
            bool keySearch = false
            ) const;


    Q_INVOKABLE void appendMissingRow(
            ZRoleRow roleRow,
            const QString& keyText,
            int keyColumn = 0);
    Q_INVOKABLE void appendMissingRow(
            QVariant roleRow,
            const QString& keyText,
            int keyColumn = 0);

    Q_INVOKABLE bool writeData(QVariant jsonData);

    Q_INVOKABLE QVariant readData() const;

    Q_INVOKABLE void putJsonData(QJsonObject data/*, bool putRoles=true*/);

    Q_INVOKABLE QJsonObject getJsonData() const;

    Q_INVOKABLE void sync();


signals:

    void tableModified(int dataRole, int rowNumber);

    void tableModelReset();

public slots:

    void moveModelToThread(QThread* targetThread);

    void invalidateModel();

protected:

    static void registerLogCategory();


    void insertTableColumnRows(
            QVariant rows,
            int startRow,
            int col,
            bool asynchronous);

    Q_INVOKABLE void mergeCells(QVariant data, bool front=true, bool truncateModel=true);



    ZRoleRow coalesceCellRow(const ZDataRow cells,
                             int startIndex,
                             int columnCount,
                             const QList<int> roles,
                             int& nextIndex);

    ZRoleRowList coalesceCellRows(
            const ZDataRow cells,
            int columnCount,
            const QList<int> roles);

    ZblDataModel m_model;

    int m_defaultRole;

    ZBL_DECLARE_LOGGED_OBJECT

};

} // Zbl

Q_DECLARE_METATYPE(Zbl::ZRoleNames)
//Q_DECLARE_METATYPE(Zbl::ZRoleNameMap)
Q_DECLARE_METATYPE(Zbl::ZDataRow)
Q_DECLARE_METATYPE(Zbl::ZRoleRow)
Q_DECLARE_METATYPE(Zbl::ZRoleRowList)
//Q_DECLARE_METATYPE(QQmlChangeSet)


#endif // ZTABLEMODEL_H