QmlObjectListModel.h 3.31 KB
Newer Older
1 2 3 4 5 6 7 8 9
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

10 11 12 13 14 15 16 17 18 19 20

#ifndef QmlObjectListModel_H
#define QmlObjectListModel_H

#include <QAbstractListModel>

class QmlObjectListModel : public QAbstractListModel
{
    Q_OBJECT
    
public:
21 22
    QmlObjectListModel(QObject* parent = nullptr);
    ~QmlObjectListModel() override;
23 24
    
    Q_PROPERTY(int count READ count NOTIFY countChanged)
Don Gagne's avatar
Don Gagne committed
25 26 27 28
    
    /// Returns true if any of the items in the list are dirty. Requires each object to have
    /// a dirty property and dirtyChanged signal.
    Q_PROPERTY(bool dirty READ dirty WRITE setDirty NOTIFY dirtyChanged)
29

Gus Grubba's avatar
Gus Grubba committed
30
    Q_INVOKABLE QObject* get(int index);
Don Gagne's avatar
Don Gagne committed
31

Don Gagne's avatar
Don Gagne committed
32 33
    // Property accessors
    
Gus Grubba's avatar
Gus Grubba committed
34 35
    int         count               () const;
    bool        dirty               () const { return _dirty; }
36

Gus Grubba's avatar
Gus Grubba committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
    void        setDirty            (bool dirty);
    void        append              (QObject* object);
    void        append              (QList<QObject*> objects);
    QObjectList swapObjectList      (const QObjectList& newlist);
    void        clear               ();
    QObject*    removeAt            (int i);
    QObject*    removeOne           (QObject* object) { return removeAt(indexOf(object)); }
    void        insert              (int i, QObject* object);
    void        insert              (int i, QList<QObject*> objects);
    bool        contains            (QObject* object) { return _objectList.indexOf(object) != -1; }
    int         indexOf             (QObject* object) { return _objectList.indexOf(object); }

    QObject*    operator[]          (int i);
    const QObject* operator[]       (int i) const;
    template<class T> T value       (int index) { return qobject_cast<T>(_objectList[index]); }
    QList<QObject*>* objectList     () { return &_objectList; }
Don Gagne's avatar
Don Gagne committed
53

Don Gagne's avatar
Don Gagne committed
54
    /// Calls deleteLater on all items and this itself.
Gus Grubba's avatar
Gus Grubba committed
55
    void deleteListAndContents      ();
Don Gagne's avatar
Don Gagne committed
56

57
    /// Clears the list and calls deleteLater on each entry
Gus Grubba's avatar
Gus Grubba committed
58
    void clearAndDeleteContents     ();
59

60 61
    void beginReset                 ();
    void endReset                   ();
Don Gagne's avatar
Don Gagne committed
62

63
signals:
Gus Grubba's avatar
Gus Grubba committed
64 65
    void countChanged               (int count);
    void dirtyChanged               (bool dirtyChanged);
Don Gagne's avatar
Don Gagne committed
66 67
    
private slots:
Gus Grubba's avatar
Gus Grubba committed
68
    void _childDirtyChanged         (bool dirty);
69 70
    
private:
71
    // Overrides from QAbstractListModel
Gus Grubba's avatar
Gus Grubba committed
72 73 74 75 76
    int         rowCount    (const QModelIndex & parent = QModelIndex()) const override;
    QVariant    data        (const QModelIndex & index, int role = Qt::DisplayRole) const override;
    bool        insertRows  (int position, int rows, const QModelIndex &index = QModelIndex()) override;
    bool        removeRows  (int position, int rows, const QModelIndex &index = QModelIndex()) override;
    bool        setData     (const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
77
    QHash<int, QByteArray> roleNames(void) const override;
Gus Grubba's avatar
Gus Grubba committed
78

79 80
private:
    QList<QObject*> _objectList;
Don Gagne's avatar
Don Gagne committed
81 82
    
    bool _dirty;
Don Gagne's avatar
Don Gagne committed
83
    bool _skipDirtyFirstItem;
84
    bool _externalBeginResetModel;
85 86
        
    static const int ObjectRole;
87
    static const int TextRole;
88 89 90
};

#endif