path: root/src/imports/location/qdeclarativegeomapitemview.cpp

/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qdeclarativegeomapitemview_p.h"
#include "qdeclarativegeomapmousearea_p.h"
#include "qdeclarativegeomap_p.h"
#include "qdeclarativegeomapitembase_p.h"

#include <QtCore/QAbstractItemModel>
#include <QtQml/QQmlParserStatus>
#include <QtQml/QQmlContext>
#include <QtQml/private/qqmlopenmetaobject_p.h>
#include <QtQml/private/qlistmodelinterface_p.h>

QT_BEGIN_NAMESPACE

/*!
    \qmlclass MapItemView QDeclarativeGeoMapItemView
    \inqmlmodule QtLocation 5
    \ingroup qml-QtLocation5-maps
    \since Qt Location 5.0
    \inherits QQuickItem

    \brief The MapItemView is used to populate Map from a model.

    The MapItemView is used to populate Map with MapItems from a model.
    The MapItemView element only makes sense when contained in a Map,
    meaning that it has no standalone presentation.

    \section2 Example Usage

    This example demonstrates how to use the MapViewItem element to display
    a \l{Route}{route} on a \l{Map}{map}:

    \snippet snippets/declarative/maps.qml QtQuick import
    \snippet snippets/declarative/maps.qml QtLocation import
    \codeline
    \snippet snippets/declarative/maps.qml MapRoute
*/

QDeclarativeGeoMapItemView::QDeclarativeGeoMapItemView(QQuickItem *parent)
    : QObject(parent), visible_(true), componentCompleted_(false), delegate_(0),
      itemModel_(0), listModel_(0), map_(0)
{
}

QDeclarativeGeoMapItemView::~QDeclarativeGeoMapItemView()
{
    if (map_)
        removeInstantiatedItems();
}

/*!
    \internal
*/
void QDeclarativeGeoMapItemView::componentComplete()
{
    componentCompleted_ = true;
}

/*!
    \qmlproperty model QtLocation5::MapItemView::model

    This property holds the model that provides data for
    populating data with delegates.
*/
QVariant QDeclarativeGeoMapItemView::model() const
{
    return modelVariant_;
}

void QDeclarativeGeoMapItemView::setModel(const QVariant &model)
{
    if (!model.isValid() || model == modelVariant_)
        return;
    QObject *object = qvariant_cast<QObject*>(model);
    QAbstractItemModel* itemModel;
    QListModelInterface* listModel;
    if (object) {
        itemModel = qobject_cast<QAbstractItemModel*>(object);
        listModel = qobject_cast<QListModelInterface*>(object);
    } else {
        return;
    }

    if (itemModel) {
        modelVariant_ = model;
        itemModel_ = itemModel;
        QObject::connect(itemModel_, SIGNAL(modelReset()),
                         this, SLOT(itemModelReset()));
        QObject::connect(itemModel_, SIGNAL(rowsRemoved(QModelIndex, int, int)),
                         this, SLOT(itemModelRowsRemoved(QModelIndex, int, int)));
        QObject::connect(itemModel_, SIGNAL(rowsInserted(QModelIndex, int, int)),
                         this, SLOT(itemModelRowsInserted(QModelIndex, int, int)));
        repopulate();
        emit modelChanged();

    } else if (listModel) {
        modelVariant_ = model;
        listModel_ = listModel;
        QObject::connect(listModel_, SIGNAL(itemsInserted(int,int)),
                         this, SLOT(listModelItemsInserted(int,int)));
        QObject::connect(listModel_, SIGNAL(itemsRemoved(int,int)),
                         this, SLOT(listModelItemsRemoved(int,int)));
        QObject::connect(listModel_, SIGNAL(itemsChanged(int,int,QList<int>)),
                         this, SLOT(listModelItemsChanged(int,int,QList<int>)));
        QObject::connect(listModel_, SIGNAL(itemsMoved(int,int,int)),
                         this, SLOT(listModelItemsMoved(int,int,int)));
        repopulate();
        emit modelChanged();
    }
}

/*!
    \internal
*/
void QDeclarativeGeoMapItemView::itemModelReset()
{
    repopulate();
}

/*!
    \internal
*/
void QDeclarativeGeoMapItemView::itemModelRowsInserted(QModelIndex, int start, int end)
{
    if (!componentCompleted_ || !map_ || !delegate_ || !itemModel_)
        return;

    QDeclarativeGeoMapItemBase* mapItem;
    for (int i = start; i <= end; ++i) {
        mapItem = createItem(i);
        if (!mapItem) {
            break;
        }
        mapItemList_.append(mapItem);
        map_->addMapItem(mapItem);
    }
}

/*!
    \internal
*/
void QDeclarativeGeoMapItemView::itemModelRowsRemoved(QModelIndex, int start, int end)
{
    if (!componentCompleted_ || !map_ || !delegate_ || !itemModel_)
        return;

    for (int i = end; i >= start; --i) {
        QDeclarativeGeoMapItemBase *mapItem = mapItemList_.takeAt(i);
        Q_ASSERT(mapItem);
        if (!mapItem) // bad
            break;
        map_->removeMapItem(mapItem);
        delete mapItem;
    }
}

void QDeclarativeGeoMapItemView::listModelItemsChanged(int index, int count, const QList<int>&)
{
    if (!componentCompleted_ || !map_ || !delegate_ || !listModel_)
        return;

    for (int i = index; i < index+count; ++i) {
        QDeclarativeGeoMapItemBase *mapItem = mapItemList_.takeAt(i);
        Q_ASSERT(mapItem);
        if (!mapItem) // bad
            break;
        map_->removeMapItem(mapItem);
        delete mapItem;

        mapItem = createItem(i);
        if (!mapItem)
            continue;
        mapItemList_.append(mapItem);
        map_->addMapItem(mapItem);
    }
}

void QDeclarativeGeoMapItemView::listModelItemsInserted(int index, int count)
{
    if (!componentCompleted_ || !map_ || !delegate_ || !listModel_)
        return;

    QDeclarativeGeoMapItemBase* mapItem;
    for (int i = index; i < index+count; ++i) {
        mapItem = createItem(i);
        if (!mapItem)
            continue;
        mapItemList_.append(mapItem);
        map_->addMapItem(mapItem);
    }
}

void QDeclarativeGeoMapItemView::listModelItemsMoved(int from, int to, int count)
{
    QList<QDeclarativeGeoMapItemBase*> temp;

    for (int i = 0; i < count; ++i)
        temp.append(mapItemList_.takeAt(from));

    int insIdx = to;
    if (to > from)
        insIdx -= count;

    for (int i = 0; i < count; ++i)
        mapItemList_.insert(insIdx, temp.takeLast());
}

void QDeclarativeGeoMapItemView::listModelItemsRemoved(int index, int count)
{
    if (!componentCompleted_ || !map_ || !delegate_ || !listModel_)
        return;

    for (int i = 0; i < count; ++i) {
        QDeclarativeGeoMapItemBase *mapItem = mapItemList_.takeAt(index);
        Q_ASSERT(mapItem);
        if (!mapItem) // bad
            break;
        map_->removeMapItem(mapItem);
        delete mapItem;
    }
}

/*!
    \qmlproperty Component QtLocation5::MapItemView::delegate

    This property holds the delegate which defines how each item in the
    model should be displayed. The Component must contain exactly one
    MapItem -derived element as the root element.

*/
QQmlComponent* QDeclarativeGeoMapItemView::delegate() const
{
    return delegate_;
}

void QDeclarativeGeoMapItemView::setDelegate(QQmlComponent *delegate)
{
    if (!delegate)
        return;
    delegate_ = delegate;

    repopulate();
    emit delegateChanged();
}

/*!
    \internal
*/
void QDeclarativeGeoMapItemView::setMapData(QDeclarativeGeoMap* map)
{
    if (!map || map_) // changing map on the fly not supported
        return;
    map_ = map;
}

/*!
    \internal
*/
void QDeclarativeGeoMapItemView::removeInstantiatedItems()
{
    if (!map_)
        return;
    for (int i = 0; i < mapItemList_.count(); ++ i) {
        map_->removeMapItem(mapItemList_.at(i));
    }
    qDeleteAll(mapItemList_);
    mapItemList_.clear();
}

/*!
    \internal
    Removes and repopulates all items.
*/
void QDeclarativeGeoMapItemView::repopulate()
{
    if (!componentCompleted_ || !map_ || !delegate_ || (!itemModel_ && !listModel_))
        return;
    // Free any earlier instances
    removeInstantiatedItems();

    // Iterate model data and instantiate delegates.
    if (itemModel_) {
        QDeclarativeGeoMapItemBase* mapItem;
        for (int i = 0; i < itemModel_->rowCount(); ++i) {
            mapItem = createItem(i);
            Q_ASSERT(mapItem);
            if (!mapItem) // bad
                break;
            mapItemList_.append(mapItem);
            map_->addMapItem(mapItem);
        }
    } else if (listModel_) {
        QDeclarativeGeoMapItemBase *mapItem;
        for (int i = 0; i < listModel_->count(); ++i) {
            mapItem = createItem(i);
            Q_ASSERT(mapItem);
            if (!mapItem)
                break;
            mapItemList_.append(mapItem);
            map_->addMapItem(mapItem);
        }
    }
}

QDeclarativeGeoMapItemBase *QDeclarativeGeoMapItemView::createItem(int modelRow)
{
    if (itemModel_)
        return createItemFromItemModel(modelRow);
    else if (listModel_)
        return createItemFromListModel(modelRow);
    else
        return 0;
}

QDeclarativeGeoMapItemBase *QDeclarativeGeoMapItemView::createItemFromListModel(int modelRow)
{
    if (!delegate_ || !listModel_)
        return 0;

    QObject *model = new QObject(this);
    QQmlOpenMetaObject *modelMetaObject = new QQmlOpenMetaObject(model);
    QQmlContext *itemContext = new QQmlContext(qmlContext(this));

    foreach (const int &roleIdx, listModel_->roles()) {
        const QString role = listModel_->toString(roleIdx);

        QVariant modelData = listModel_->data(modelRow, roleIdx);
        if (!modelData.isValid())
            continue;

        itemContext->setContextProperty(role, modelData);
        modelMetaObject->setValue(role.toLocal8Bit(), modelData);
    }
    itemContext->setContextProperty(QLatin1String("model"), model);

    QObject* obj = delegate_->create(itemContext);

    if (!obj) {
        qWarning() << "QDeclarativeGeoMapItemView map item creation failed.";
        delete itemContext;
        return 0;
    }
    QDeclarativeGeoMapItemBase *declMapObj =  qobject_cast<QDeclarativeGeoMapItemBase*>(obj);
    if (!declMapObj) {
        qWarning() << "QDeclarativeGeoMapItemView map item delegate is of unsupported type.";
        delete itemContext;
        return 0;
    }
    itemContext->setParent(declMapObj);
    model->setParent(declMapObj);
    return declMapObj;
}

/*!
    \internal
*/
QDeclarativeGeoMapItemBase* QDeclarativeGeoMapItemView::createItemFromItemModel(int modelRow)
{
    if (!delegate_ || !itemModel_)
        return 0;

    QModelIndex index = itemModel_->index(modelRow, 0); // column 0
    if (!index.isValid()) {
        qWarning() << "QDeclarativeGeoMapItemView Index is not valid: " << modelRow;
        return 0;
    }

    QObject *model = new QObject(this);
    QQmlOpenMetaObject *modelMetaObject = new QQmlOpenMetaObject(model);

    QHashIterator<int, QByteArray> iterator(itemModel_->roleNames());
    QQmlContext *itemContext = new QQmlContext(qmlContext(this));
    while (iterator.hasNext()) {
        iterator.next();
        QVariant modelData = itemModel_->data(index, iterator.key());
        if (!modelData.isValid())
            continue;

        itemContext->setContextProperty(QString::fromLatin1(iterator.value().constData()),
                                        modelData);

        modelMetaObject->setValue(iterator.value(), modelData);
    }
    itemContext->setContextProperty(QLatin1String("model"), model);

    QObject* obj = delegate_->create(itemContext);

    if (!obj) {
        qWarning() << "QDeclarativeGeoMapItemView map item creation failed.";
        delete itemContext;
        return 0;
    }
    QDeclarativeGeoMapItemBase *declMapObj =  qobject_cast<QDeclarativeGeoMapItemBase*>(obj);
    if (!declMapObj) {
        qWarning() << "QDeclarativeGeoMapItemView map item delegate is of unsupported type.";
        delete itemContext;
        return 0;
    }
    itemContext->setParent(declMapObj);
    model->setParent(declMapObj);
    return declMapObj;
}

/*!
    \qmlproperty bool QtLocation5::MapItemView::visible

    This property holds whether the delegate objects created from the
    model are visible or not. Default value is true.
*/

void QDeclarativeGeoMapItemView::setVisible(bool visible)
{
    // TODO!
    Q_UNUSED(visible);
}

bool QDeclarativeGeoMapItemView::isVisible() const
{
    return visible_;
}

/*!
    \qmlproperty int QtLocation5::MapItemView::z

    This property holds the z-value of the MapItemView.
    It determines the z-value of the instantiated delegates.

    As with other Map items, objects with same z-value are
    drawn in insertion order.

*/
void QDeclarativeGeoMapItemView::setZValue(qreal zValue)
{
    // TODO z values
    Q_UNUSED(zValue);
    // group_.setZValue(zValue);
    // emit zChanged();
}

qreal QDeclarativeGeoMapItemView::zValue()
{
    // TODO z values what to do
    return 1.0;
    //return group_.zValue();
}

#include "moc_qdeclarativegeomapitemview_p.cpp"

QT_END_NAMESPACE