QmlObjectListModel.cc 7.16 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

/// @file
///     @author Don Gagne <don@thegagnes.com>

#include "QmlObjectListModel.h"

#include <QDebug>
Don Gagne's avatar
Don Gagne committed
17
#include <QQmlEngine>
18 19

const int QmlObjectListModel::ObjectRole = Qt::UserRole;
20
const int QmlObjectListModel::TextRole = Qt::UserRole + 1;
21 22 23

QmlObjectListModel::QmlObjectListModel(QObject* parent)
    : QAbstractListModel(parent)
Don Gagne's avatar
Don Gagne committed
24
    , _dirty(false)
Don Gagne's avatar
Don Gagne committed
25
    , _skipDirtyFirstItem(false)
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
{

}

QmlObjectListModel::~QmlObjectListModel()
{
    
}

int QmlObjectListModel::rowCount(const QModelIndex& parent) const
{
    Q_UNUSED(parent);
    
    return _objectList.count();
}

QVariant QmlObjectListModel::data(const QModelIndex &index, int role) const
{
    if (!index.isValid()) {
        return QVariant();
    }
    
Gus Grubba's avatar
Gus Grubba committed
48
    if (index.row() < 0 || index.row() >= _objectList.count()) {
49 50 51 52 53
        return QVariant();
    }
    
    if (role == ObjectRole) {
        return QVariant::fromValue(_objectList[index.row()]);
54 55
    } else if (role == TextRole) {
        return QVariant::fromValue(_objectList[index.row()]->objectName());
56 57 58 59 60 61 62 63 64 65
    } else {
        return QVariant();
    }
}

QHash<int, QByteArray> QmlObjectListModel::roleNames(void) const
{
    QHash<int, QByteArray> hash;
    
    hash[ObjectRole] = "object";
66
    hash[TextRole] = "text";
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
    
    return hash;
}

bool QmlObjectListModel::setData(const QModelIndex& index, const QVariant& value, int role)
{
    if (index.isValid() && role == ObjectRole) {
        _objectList.replace(index.row(), value.value<QObject*>());
        emit dataChanged(index, index);
        return true;
    }
    
    return false;
}

bool QmlObjectListModel::insertRows(int position, int rows, const QModelIndex& parent)
{
    Q_UNUSED(parent);
    
86 87 88 89
    if (position < 0 || position > _objectList.count() + 1) {
        qWarning() << "Invalid position position:count" << position << _objectList.count();
    }
    
90 91 92 93 94 95 96 97 98 99 100 101
    beginInsertRows(QModelIndex(), position, position + rows - 1);
    endInsertRows();
    
    emit countChanged(count());
    
    return true;
}

bool QmlObjectListModel::removeRows(int position, int rows, const QModelIndex& parent)
{
    Q_UNUSED(parent);
    
102 103 104 105 106 107
    if (position < 0 || position >= _objectList.count()) {
        qWarning() << "Invalid position position:count" << position << _objectList.count();
    } else if (position + rows > _objectList.count()) {
        qWarning() << "Invalid rows position:rows:count" << position << rows << _objectList.count();
    }
    
108 109 110 111 112 113 114 115 116 117 118
    beginRemoveRows(QModelIndex(), position, position + rows - 1);
    for (int row=0; row<rows; row++) {
        _objectList.removeAt(position);
    }
    endRemoveRows();
    
    emit countChanged(count());
    
    return true;
}

Don Gagne's avatar
Don Gagne committed
119 120
QObject* QmlObjectListModel::operator[](int index)
{
Gus Grubba's avatar
Gus Grubba committed
121 122 123
    if (index < 0 || index >= _objectList.count()) {
        return NULL;
    }
Don Gagne's avatar
Don Gagne committed
124 125 126 127
    return _objectList[index];
}

const QObject* QmlObjectListModel::operator[](int index) const
128
{
Gus Grubba's avatar
Gus Grubba committed
129 130 131
    if (index < 0 || index >= _objectList.count()) {
        return NULL;
    }
132 133 134
    return _objectList[index];
}

Gus Grubba's avatar
Gus Grubba committed
135
void QmlObjectListModel::clear()
136 137
{
    while (rowCount()) {
Don Gagne's avatar
Don Gagne committed
138
        removeAt(0);
139 140 141
    }
}

Don Gagne's avatar
Don Gagne committed
142
QObject* QmlObjectListModel::removeAt(int i)
143
{
Don Gagne's avatar
Don Gagne committed
144
    QObject* removedObject = _objectList[i];
145 146 147 148 149 150
    if(removedObject) {
        // Look for a dirtyChanged signal on the object
        if (_objectList[i]->metaObject()->indexOfSignal(QMetaObject::normalizedSignature("dirtyChanged(bool)")) != -1) {
            if (!_skipDirtyFirstItem || i != 0) {
                QObject::disconnect(_objectList[i], SIGNAL(dirtyChanged(bool)), this, SLOT(_childDirtyChanged(bool)));
            }
Don Gagne's avatar
Don Gagne committed
151
        }
Don Gagne's avatar
Don Gagne committed
152
    }
153
    removeRows(i, 1);
154
    setDirty(true);
Don Gagne's avatar
Don Gagne committed
155
    return removedObject;
156 157
}

158 159 160 161 162 163
void QmlObjectListModel::insert(int i, QObject* object)
{
    if (i < 0 || i > _objectList.count()) {
        qWarning() << "Invalid index index:count" << i << _objectList.count();
    }
    
Don Gagne's avatar
Don Gagne committed
164
    QQmlEngine::setObjectOwnership(object, QQmlEngine::CppOwnership);
Don Gagne's avatar
Don Gagne committed
165 166 167
    
    // Look for a dirtyChanged signal on the object
    if (object->metaObject()->indexOfSignal(QMetaObject::normalizedSignature("dirtyChanged(bool)")) != -1) {
Don Gagne's avatar
Don Gagne committed
168 169 170
        if (!_skipDirtyFirstItem || i != 0) {
            QObject::connect(object, SIGNAL(dirtyChanged(bool)), this, SLOT(_childDirtyChanged(bool)));
        }
Don Gagne's avatar
Don Gagne committed
171
    }
Don Gagne's avatar
Don Gagne committed
172

173 174
    _objectList.insert(i, object);
    insertRows(i, 1);
175 176
    
    setDirty(true);
177 178
}

179 180 181 182 183 184 185
void QmlObjectListModel::insert(int i, QList<QObject*> objects)
{
    if (i < 0 || i > _objectList.count()) {
        qWarning() << "Invalid index index:count" << i << _objectList.count();
    }

    int j = i;
186
    for (QObject* object: objects) {
187 188 189 190 191 192 193 194 195 196
        QQmlEngine::setObjectOwnership(object, QQmlEngine::CppOwnership);

        // Look for a dirtyChanged signal on the object
        if (object->metaObject()->indexOfSignal(QMetaObject::normalizedSignature("dirtyChanged(bool)")) != -1) {
            if (!_skipDirtyFirstItem || j != 0) {
                QObject::connect(object, SIGNAL(dirtyChanged(bool)), this, SLOT(_childDirtyChanged(bool)));
            }
        }
        j++;

197
        _objectList.insert(j, object);
198 199 200 201 202 203 204
    }

    insertRows(i, objects.count());

    setDirty(true);
}

205 206
void QmlObjectListModel::append(QObject* object)
{
207
    insert(_objectList.count(), object);
208 209
}

210 211 212 213 214
void QmlObjectListModel::append(QList<QObject*> objects)
{
    insert(_objectList.count(), objects);
}

215
QObjectList QmlObjectListModel::swapObjectList(const QObjectList& newlist)
216 217 218 219 220
{
    QObjectList oldlist(_objectList);
    beginResetModel();
    _objectList = newlist;
    endResetModel();
221
    emit countChanged(count());
222 223 224
    return oldlist;
}

Gus Grubba's avatar
Gus Grubba committed
225
int QmlObjectListModel::count() const
226 227 228 229
{
    return rowCount();
}

Don Gagne's avatar
Don Gagne committed
230 231
void QmlObjectListModel::setDirty(bool dirty)
{
232 233 234 235
    if (_dirty != dirty) {
        _dirty = dirty;
        if (!dirty) {
            // Need to clear dirty from all children
236
            for(QObject* object: _objectList) {
237 238 239
                if (object->property("dirty").isValid()) {
                    object->setProperty("dirty", false);
                }
Don Gagne's avatar
Don Gagne committed
240 241
            }
        }
242
        emit dirtyChanged(_dirty);
Don Gagne's avatar
Don Gagne committed
243 244 245 246 247 248
    }
}

void QmlObjectListModel::_childDirtyChanged(bool dirty)
{
    _dirty |= dirty;
249 250
    // We want to emit dirtyChanged even if the actual value of _dirty didn't change. It can be a useful
    // signal to know when a child has changed dirty state
Don Gagne's avatar
Don Gagne committed
251 252
    emit dirtyChanged(_dirty);
}
Don Gagne's avatar
Don Gagne committed
253

Gus Grubba's avatar
Gus Grubba committed
254
void QmlObjectListModel::deleteListAndContents()
Don Gagne's avatar
Don Gagne committed
255 256 257 258 259 260
{
    for (int i=0; i<_objectList.count(); i++) {
        _objectList[i]->deleteLater();
    }
    deleteLater();
}
Don Gagne's avatar
Don Gagne committed
261

Gus Grubba's avatar
Gus Grubba committed
262
void QmlObjectListModel::clearAndDeleteContents()
Don Gagne's avatar
Don Gagne committed
263
{
264
    beginResetModel();
Don Gagne's avatar
Don Gagne committed
265 266 267 268
    for (int i=0; i<_objectList.count(); i++) {
        _objectList[i]->deleteLater();
    }
    clear();
269
    endResetModel();
Don Gagne's avatar
Don Gagne committed
270
}
271 272 273 274 275 276 277 278 279

void swap(QmlObjectListModel &list1, QmlObjectListModel &list2)
{
    using std::swap;

    swap(list1._objectList, list2._objectList);
    swap(list1._dirty, list2._dirty);
    swap(list1._skipDirtyFirstItem, list2._skipDirtyFirstItem);
}