QmlObjectListModel.h 2.71 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 21 22 23 24

#ifndef QmlObjectListModel_H
#define QmlObjectListModel_H

#include <QAbstractListModel>

class QmlObjectListModel : public QAbstractListModel
{
    Q_OBJECT
    
public:
    QmlObjectListModel(QObject* parent = NULL);
    ~QmlObjectListModel();
    
    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

Don Gagne's avatar
Don Gagne committed
30 31
    Q_INVOKABLE QObject* get(int index)     { return _objectList[index]; }

Don Gagne's avatar
Don Gagne committed
32 33
    // Property accessors
    
Don Gagne's avatar
Don Gagne committed
34
    int count(void) const;
Don Gagne's avatar
Don Gagne committed
35 36 37 38
    
    bool dirty(void) { return _dirty; }
    void setDirty(bool dirty);
    
39
    void append(QObject* object);
40
    QObjectList swapObjectList(const QObjectList& newlist);
41
    void clear(void);
Don Gagne's avatar
Don Gagne committed
42
    QObject* removeAt(int i);
Don Gagne's avatar
Don Gagne committed
43
    QObject* removeOne(QObject* object) { return removeAt(indexOf(object)); }
44
    void insert(int i, QObject* object);
Don Gagne's avatar
Don Gagne committed
45 46
    QObject* operator[](int i);
    const QObject* operator[](int i) const;
Don Gagne's avatar
Don Gagne committed
47 48 49 50
    bool contains(QObject* object) { return _objectList.indexOf(object) != -1; }
    int indexOf(QObject* object) { return _objectList.indexOf(object); }
    template<class T> T value(int index) { return qobject_cast<T>(_objectList[index]); }

Don Gagne's avatar
Don Gagne committed
51 52 53
    /// Calls deleteLater on all items and this itself.
    void deleteListAndContents(void);

Don Gagne's avatar
Don Gagne committed
54 55 56
    /// Clears the list and calls delete on each entry
    void clearAndDeleteContents(void);

57 58
signals:
    void countChanged(int count);
Don Gagne's avatar
Don Gagne committed
59 60 61 62
    void dirtyChanged(bool dirtyChanged);
    
private slots:
    void _childDirtyChanged(bool dirty);
63 64
    
private:
65 66 67 68 69 70 71 72 73 74
    // Overrides from QAbstractListModel
    virtual int	rowCount(const QModelIndex & parent = QModelIndex()) const;
    virtual QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const;
    virtual QHash<int, QByteArray> roleNames(void) const;
    virtual bool insertRows(int position, int rows, const QModelIndex &index = QModelIndex());
    virtual bool removeRows(int position, int rows, const QModelIndex &index = QModelIndex());
    virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
	
private:
    QList<QObject*> _objectList;
Don Gagne's avatar
Don Gagne committed
75 76
    
    bool _dirty;
Don Gagne's avatar
Don Gagne committed
77
    bool _skipDirtyFirstItem;
78 79
        
    static const int ObjectRole;
80
    static const int TextRole;
81 82 83
};

#endif