AbstractDataPluginModel.h

Go to the documentation of this file.

//
// This file is part of the Marble Virtual Globe.
//
// This program is free software licensed under the GNU LGPL. You can
// find a copy of this license in LICENSE.txt in the top directory of
// the source code.
//
// Copyright 2009      Bastian Holst <bastianholst@gmx.de>
//

#ifndef MARBLE_ABSTRACTDATAPLUGINMODEL_H
#define MARBLE_ABSTRACTDATAPLUGINMODEL_H

#include <QObject>
#include <QList>
#include <QHash>
#include <QString>

#include "marble_export.h"
#include "MarbleGlobal.h"

class QPoint;
class QUrl;
class QAbstractItemModel;

namespace Marble
{
    
class AbstractDataPluginModelPrivate;
class AbstractDataPluginItem;
class GeoDataLatLonAltBox;
class MarbleModel;
class ViewportParams;

class MARBLE_EXPORT AbstractDataPluginModel : public QObject
{
    Q_OBJECT

    Q_PROPERTY( QObject* favoritesModel READ favoritesModel CONSTANT )
 
 public:
    explicit AbstractDataPluginModel( const QString& name, const MarbleModel *marbleModel, QObject *parent = 0 );
    virtual ~AbstractDataPluginModel();
        
    const MarbleModel *marbleModel() const;

    QList<AbstractDataPluginItem*> items( const ViewportParams *viewport,
                                          qint32 number = 10 );
    
    QList<AbstractDataPluginItem *> whichItemAt( const QPoint& curpos );

    void setItemSettings( QHash<QString,QVariant> itemSettings );

    virtual void setFavoriteItems( const QStringList& list );
    QStringList favoriteItems() const;

    void setFavoriteItemsOnly( bool favoriteOnly );
    bool isFavoriteItemsOnly() const;

    QObject* favoritesModel();

    AbstractDataPluginItem *findItem( const QString& id ) const;

    bool itemExists( const QString& id ) const;

public Q_SLOTS:
    void addItemsToList( const QList<AbstractDataPluginItem*> &items );

    void addItemToList( AbstractDataPluginItem *item );

    void clear();

 protected:
    virtual void getAdditionalItems( const GeoDataLatLonAltBox& box,
                                     qint32 number = 10 ) = 0;

    virtual void getItem( const QString &id );
       
    virtual void parseFile( const QByteArray& file );
        
    void downloadItem( const QUrl& url, const QString& type, AbstractDataPluginItem *item );

    MARBLE_DEPRECATED( void downloadItemData( const QUrl& url, const QString& type, AbstractDataPluginItem *item ) );
    
    void downloadDescriptionFile( const QUrl& url );

    QString generateFilename( const QString& id, const QString& type ) const;
    
    QString generateFilepath( const QString& id, const QString& type ) const;
    
    bool fileExists( const QString& fileName ) const;
    
    bool fileExists( const QString& id, const QString& type ) const;

    void registerItemProperties( const QMetaObject& item );
    
 private Q_SLOTS:
    void handleChangedViewport();
    
    void processFinishedJob( const QString& relativeUrlString, const QString& id );
    
    void removeItem( QObject *item );

    void favoriteItemChanged( const QString& id, bool isFavorite );

    void scheduleItemSort();

 Q_SIGNALS:
    void itemsUpdated();
    void favoriteItemsChanged( const QStringList& favoriteItems );
    void favoriteItemsOnlyChanged();

 private:
    AbstractDataPluginModelPrivate * const d;
    friend class AbstractDataPluginModelPrivate;
};

}

#endif