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

QmlObjectListModel::QmlObjectListModel(QObject* parent)
23 24 25 26
    : QAbstractListModel        (parent)
    , _dirty                    (false)
    , _skipDirtyFirstItem       (false)
    , _externalBeginResetModel  (false)
27 28 29 30 31 32 33 34 35
{

}

QmlObjectListModel::~QmlObjectListModel()
{
    
}

Gus Grubba's avatar
Gus Grubba committed
36 37 38 39 40 41 42 43
QObject* QmlObjectListModel::get(int index)
{
    if (index < 0 || index >= _objectList.count()) {
        return nullptr;
    }
    return _objectList[index];
}

44 45 46 47 48 49 50 51 52 53 54 55 56
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
57
    if (index.row() < 0 || index.row() >= _objectList.count()) {
58 59 60 61 62
        return QVariant();
    }
    
    if (role == ObjectRole) {
        return QVariant::fromValue(_objectList[index.row()]);
63 64
    } else if (role == TextRole) {
        return QVariant::fromValue(_objectList[index.row()]->objectName());
65 66 67 68 69 70 71 72 73 74
    } else {
        return QVariant();
    }
}

QHash<int, QByteArray> QmlObjectListModel::roleNames(void) const
{
    QHash<int, QByteArray> hash;
    
    hash[ObjectRole] = "object";
75
    hash[TextRole] = "text";
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
    
    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);
    
95 96 97 98
    if (position < 0 || position > _objectList.count() + 1) {
        qWarning() << "Invalid position position:count" << position << _objectList.count();
    }
    
99 100 101 102 103 104 105 106 107 108 109 110
    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);
    
111 112 113 114 115 116
    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();
    }
    
117 118 119 120 121 122 123 124 125 126 127
    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
128 129
QObject* QmlObjectListModel::operator[](int index)
{
Gus Grubba's avatar
Gus Grubba committed
130
    if (index < 0 || index >= _objectList.count()) {
131
        return nullptr;
Gus Grubba's avatar
Gus Grubba committed
132
    }
Don Gagne's avatar
Don Gagne committed
133 134 135 136
    return _objectList[index];
}

const QObject* QmlObjectListModel::operator[](int index) const
137
{
Gus Grubba's avatar
Gus Grubba committed
138
    if (index < 0 || index >= _objectList.count()) {
139
        return nullptr;
Gus Grubba's avatar
Gus Grubba committed
140
    }
141 142 143
    return _objectList[index];
}

Gus Grubba's avatar
Gus Grubba committed
144
void QmlObjectListModel::clear()
145
{
146 147 148 149 150 151 152
    if (!_externalBeginResetModel) {
        beginResetModel();
    }
    _objectList.clear();
    if (!_externalBeginResetModel) {
        endResetModel();
        emit countChanged(count());
153 154 155
    }
}

Don Gagne's avatar
Don Gagne committed
156
QObject* QmlObjectListModel::removeAt(int i)
157
{
Don Gagne's avatar
Don Gagne committed
158
    QObject* removedObject = _objectList[i];
159 160 161 162 163 164
    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
165
        }
Don Gagne's avatar
Don Gagne committed
166
    }
167
    removeRows(i, 1);
168
    setDirty(true);
Don Gagne's avatar
Don Gagne committed
169
    return removedObject;
170 171
}

172 173 174 175 176
void QmlObjectListModel::insert(int i, QObject* object)
{
    if (i < 0 || i > _objectList.count()) {
        qWarning() << "Invalid index index:count" << i << _objectList.count();
    }
Gus Grubba's avatar
Gus Grubba committed
177 178 179 180 181 182 183
    if(object) {
        QQmlEngine::setObjectOwnership(object, QQmlEngine::CppOwnership);
        // Look for a dirtyChanged signal on the object
        if (object->metaObject()->indexOfSignal(QMetaObject::normalizedSignature("dirtyChanged(bool)")) != -1) {
            if (!_skipDirtyFirstItem || i != 0) {
                QObject::connect(object, SIGNAL(dirtyChanged(bool)), this, SLOT(_childDirtyChanged(bool)));
            }
Don Gagne's avatar
Don Gagne committed
184
        }
Don Gagne's avatar
Don Gagne committed
185
    }
186 187
    _objectList.insert(i, object);
    insertRows(i, 1);
188
    setDirty(true);
189 190
}

191 192 193 194 195 196 197
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;
198
    for (QObject* object: objects) {
199 200 201 202 203 204 205 206 207 208
        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++;

209
        _objectList.insert(j, object);
210 211 212 213 214 215 216
    }

    insertRows(i, objects.count());

    setDirty(true);
}

217 218
void QmlObjectListModel::append(QObject* object)
{
219
    insert(_objectList.count(), object);
220 221
}

222 223 224 225 226
void QmlObjectListModel::append(QList<QObject*> objects)
{
    insert(_objectList.count(), objects);
}

227
QObjectList QmlObjectListModel::swapObjectList(const QObjectList& newlist)
228 229
{
    QObjectList oldlist(_objectList);
230 231 232
    if (!_externalBeginResetModel) {
        beginResetModel();
    }
233
    _objectList = newlist;
234 235 236 237
    if (!_externalBeginResetModel) {
        endResetModel();
        emit countChanged(count());
    }
238 239 240
    return oldlist;
}

Gus Grubba's avatar
Gus Grubba committed
241
int QmlObjectListModel::count() const
242 243 244 245
{
    return rowCount();
}

Don Gagne's avatar
Don Gagne committed
246 247
void QmlObjectListModel::setDirty(bool dirty)
{
248 249 250 251
    if (_dirty != dirty) {
        _dirty = dirty;
        if (!dirty) {
            // Need to clear dirty from all children
252
            for(QObject* object: _objectList) {
253 254 255
                if (object->property("dirty").isValid()) {
                    object->setProperty("dirty", false);
                }
Don Gagne's avatar
Don Gagne committed
256 257
            }
        }
258
        emit dirtyChanged(_dirty);
Don Gagne's avatar
Don Gagne committed
259 260 261 262 263 264
    }
}

void QmlObjectListModel::_childDirtyChanged(bool dirty)
{
    _dirty |= dirty;
265 266
    // 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
267 268
    emit dirtyChanged(_dirty);
}
Don Gagne's avatar
Don Gagne committed
269

Gus Grubba's avatar
Gus Grubba committed
270
void QmlObjectListModel::deleteListAndContents()
Don Gagne's avatar
Don Gagne committed
271 272 273 274 275 276
{
    for (int i=0; i<_objectList.count(); i++) {
        _objectList[i]->deleteLater();
    }
    deleteLater();
}
Don Gagne's avatar
Don Gagne committed
277

Gus Grubba's avatar
Gus Grubba committed
278
void QmlObjectListModel::clearAndDeleteContents()
Don Gagne's avatar
Don Gagne committed
279
{
280
    beginResetModel();
Don Gagne's avatar
Don Gagne committed
281 282 283 284
    for (int i=0; i<_objectList.count(); i++) {
        _objectList[i]->deleteLater();
    }
    clear();
285
    endResetModel();
Don Gagne's avatar
Don Gagne committed
286
}
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304

void QmlObjectListModel::beginReset(void)
{
    if (_externalBeginResetModel) {
        qWarning() << "QmlObjectListModel::beginReset already set";
    }
    _externalBeginResetModel = true;
    beginResetModel();
}

void QmlObjectListModel::endReset(void)
{
    if (!_externalBeginResetModel) {
        qWarning() << "QmlObjectListModel::endReset begin not set";
    }
    _externalBeginResetModel = false;
    endResetModel();
}