qgscptcityarchive.h

Go to the documentation of this file.

/***************************************************************************
    qgscptcityarchive.h
    ---------------------
    begin                : August 2012
    copyright            : (C) 2009 by Martin Dobias
    copyright            : (C) 2012 by Etienne Tourigny
    email                : etourigny.dev at gmail.com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSCPTCITYARCHIVE_H
#define QGSCPTCITYARCHIVE_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscolorrampimpl.h"
 
#include <QAbstractItemModel>
#include <QIcon>
#include <QMimeData>
 
class QgsCptCityColorRamp;
class QgsCptCityDataItem;
class QgsCptCitySelectionItem;
class QgsSettingsEntryString;
 
#define DEFAULT_CPTCITY_ARCHIVE "cpt-city-qgis-min"

class CORE_EXPORT QgsCptCityArchive
{
  public:
    static const QgsSettingsEntryString *settingsCptCityBaseDir SIP_SKIP;
 
    static const QgsSettingsEntryString *settingsCptCityArchiveName SIP_SKIP;
 
    QgsCptCityArchive( const QString &archiveName = DEFAULT_CPTCITY_ARCHIVE, const QString &baseDir = QString() );
    ~QgsCptCityArchive();
 
    QgsCptCityArchive( const QgsCptCityArchive &rh ) = delete;
    QgsCptCityArchive &operator=( const QgsCptCityArchive &rh ) = delete;
 
    // basic dir info
    QString baseDir() const;
    static QString baseDir( QString archiveName );
    static QString defaultBaseDir();
    void setBaseDir( const QString &dirName ) { mBaseDir = dirName; }
 
    // collection + selection info
    QString copyingFileName( const QString &dirName ) const;
    QString descFileName( const QString &dirName ) const;
    static QString findFileName( const QString &target, const QString &startDir, const QString &baseDir );
    static QMap< QString, QString > copyingInfo( const QString &fileName );
    static QMap< QString, QString > description( const QString &fileName );
    static QMap< double, QPair<QColor, QColor> > gradientColorMap( const QString &fileName ) SIP_SKIP;
 
    // archive management
    bool isEmpty() const;
    QString archiveName() const { return mArchiveName; }
    static void initArchives( bool loadAll = false );
    static void initArchive( const QString &archiveName, const QString &archiveBaseDir );
    static void initDefaultArchive();
    static void clearArchives();
    static QgsCptCityArchive *defaultArchive();
    static QMap< QString, QgsCptCityArchive * > archiveRegistry();
 
    // items
    QVector< QgsCptCityDataItem * > rootItems() const { return mRootItems; }
    QVector< QgsCptCityDataItem * > selectionItems() const { return mSelectionItems; }
 
  private:
    QString mArchiveName;
    QString mBaseDir;
    // root items, namely directories at root of archive
    QVector< QgsCptCityDataItem * > mRootItems;
    QVector<QgsCptCityDataItem *> mSelectionItems;
 
  private:
#ifdef SIP_RUN
    QgsCptCityArchive( const QgsCptCityArchive &rh );
#endif
};

class CORE_EXPORT QgsCptCityDataItem : public QObject
{
    Q_OBJECT
  public:
    enum Type
    {
      ColorRamp,
      Collection,
      Directory,
      Selection,
      AllRamps
    };
 
    QgsCptCityDataItem( QgsCptCityDataItem::Type type, QgsCptCityDataItem *parent, const QString &name, const QString &path );
 
    bool hasChildren();
 
    int rowCount();

    virtual int leafCount() const;
 
    //
 
    virtual void refresh();

    virtual QVector<QgsCptCityDataItem *> createChildren();

    virtual void populate();

    bool isPopulated() { return mPopulated; }

    virtual void addChildItem( QgsCptCityDataItem *child SIP_TRANSFER, bool refresh = false );

    virtual void deleteChildItem( QgsCptCityDataItem *child );

    virtual QgsCptCityDataItem *removeChildItem( QgsCptCityDataItem *child ) SIP_TRANSFERBACK;

    virtual bool equal( const QgsCptCityDataItem *other );

    Q_DECL_DEPRECATED virtual QWidget *paramWidget() SIP_DEPRECATED { return nullptr; }

    Q_DECL_DEPRECATED virtual bool acceptDrop() SIP_DEPRECATED { return false; }

    Q_DECL_DEPRECATED virtual bool handleDrop( const QMimeData *data, Qt::DropAction action ) SIP_DEPRECATED
    {
      Q_UNUSED( data );
      Q_UNUSED( action );
      return false;
    }
 
    // static methods

    static int findItem( QVector<QgsCptCityDataItem *> items, QgsCptCityDataItem *item );
 
    // members
 
    Type type() const { return mType; }
    QgsCptCityDataItem *parent() const { return mParent; }
    void setParent( QgsCptCityDataItem *parent ) { mParent = parent; }
    QVector<QgsCptCityDataItem *> children() const { return mChildren; }
    virtual QIcon icon() { return mIcon; }
    virtual QIcon icon( QSize size )
    {
      Q_UNUSED( size )
      return icon();
    }
    QString name() const { return mName; }
    QString path() const { return mPath; }
    QString info() const { return mInfo; }
    QString shortInfo() const { return mShortInfo; }
 
    void setIcon( const QIcon &icon ) { mIcon = icon; }
 
    void setToolTip( const QString &msg ) { mToolTip = msg; }
    QString toolTip() const { return mToolTip; }
 
    bool isValid() { return mValid; }
 
  protected:
    Type mType;
    QgsCptCityDataItem *mParent = nullptr;
    QVector<QgsCptCityDataItem *> mChildren; // easier to have it always
    bool mPopulated = false;
    QString mName;
    QString mPath; // it is also used to identify item in tree
    QString mInfo;
    QString mShortInfo;
    QString mToolTip;
    QIcon mIcon;
    bool mValid = true;
 
  signals:

    void beginInsertItems( QgsCptCityDataItem *parent, int first, int last );

    void endInsertItems();

    void beginRemoveItems( QgsCptCityDataItem *parent, int first, int last );

    void endRemoveItems();
};

class CORE_EXPORT QgsCptCityColorRampItem : public QgsCptCityDataItem
{
    Q_OBJECT
  public:
    QgsCptCityColorRampItem( QgsCptCityDataItem *parent, const QString &name, const QString &path, const QString &variantName = QString(), bool initialize = false );
    QgsCptCityColorRampItem( QgsCptCityDataItem *parent, const QString &name, const QString &path, const QStringList &variantList, bool initialize = false );
 
    // --- reimplemented from QgsCptCityDataItem ---
 
    bool equal( const QgsCptCityDataItem *other ) override;
    int leafCount() const override { return 1; }
 
    // --- New virtual methods for layer item derived classes ---
    const QgsCptCityColorRamp &ramp() const { return mRamp; }
    QIcon icon() override;
    QIcon icon( QSize size ) override;
    void init();
 
  protected:
    bool mInitialized;
    QgsCptCityColorRamp mRamp;
    QList< QIcon > mIcons;
};
 

class CORE_EXPORT QgsCptCityCollectionItem : public QgsCptCityDataItem
{
    Q_OBJECT
  public:
    QgsCptCityCollectionItem( QgsCptCityDataItem *parent, const QString &name, const QString &path );
    ~QgsCptCityCollectionItem() override;
 
    void setPopulated() { mPopulated = true; }
    void addChild( QgsCptCityDataItem *item SIP_TRANSFER ) { mChildren.append( item ); }
    QVector<QgsCptCityDataItem *> childrenRamps( bool recursive );
 
  protected:
    bool mPopulatedRamps = false;
};

class CORE_EXPORT QgsCptCityDirectoryItem : public QgsCptCityCollectionItem
{
    Q_OBJECT
  public:
    QgsCptCityDirectoryItem( QgsCptCityDataItem *parent, const QString &name, const QString &path );
 
    QVector<QgsCptCityDataItem *> createChildren() override;
 
    bool equal( const QgsCptCityDataItem *other ) override;
 
    static QgsCptCityDataItem *dataItem( QgsCptCityDataItem *parent, const QString &name, const QString &path );
 
  protected:
    QMap< QString, QStringList > rampsMap();
    QStringList dirEntries() const;
    QMap< QString, QStringList > mRampsMap;
};

class CORE_EXPORT QgsCptCitySelectionItem : public QgsCptCityCollectionItem
{
    Q_OBJECT
  public:
    QgsCptCitySelectionItem( QgsCptCityDataItem *parent, const QString &name, const QString &path );
 
    QVector<QgsCptCityDataItem *> createChildren() override;
 
    bool equal( const QgsCptCityDataItem *other ) override;
 
    QStringList selectionsList() const { return mSelectionsList; }
 
  protected:
    void parseXml();
    QStringList mSelectionsList;
};

class CORE_EXPORT QgsCptCityAllRampsItem : public QgsCptCityCollectionItem
{
    Q_OBJECT
  public:
    QgsCptCityAllRampsItem( QgsCptCityDataItem *parent, const QString &name, const QVector<QgsCptCityDataItem *> &items );
 
    QVector<QgsCptCityDataItem *> createChildren() override;
 
  protected:
    QVector<QgsCptCityDataItem *> mItems;
};

class CORE_EXPORT QgsCptCityBrowserModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    enum ViewType
    {
      Authors = 0,
      Selections = 1,
      List = 2 // not used anymore
    };
 
    QgsCptCityBrowserModel( QObject *parent SIP_TRANSFERTHIS = nullptr, QgsCptCityArchive *archive = QgsCptCityArchive::defaultArchive(), ViewType Type = Authors );
    ~QgsCptCityBrowserModel() override;
 
    // implemented methods from QAbstractItemModel for read-only access
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
 
    QModelIndex findItem( QgsCptCityDataItem *item, QgsCptCityDataItem *parent = nullptr ) const;
 
    QModelIndex parent( const QModelIndex &index ) const override;

    QgsCptCityDataItem *dataItem( const QModelIndex &idx ) const;
 
    bool hasChildren( const QModelIndex &parent = QModelIndex() ) const override;

    void reload();

    void refresh( const QString &path );

    void refresh( const QModelIndex &index = QModelIndex() );

    QModelIndex findPath( const QString &path );
 
    void connectItem( QgsCptCityDataItem *item );
 
    bool canFetchMore( const QModelIndex &parent ) const override;
    void fetchMore( const QModelIndex &parent ) override;
 
  public slots:
 
    void beginInsertItems( QgsCptCityDataItem *parent, int first, int last );
    void endInsertItems();
    void beginRemoveItems( QgsCptCityDataItem *parent, int first, int last );
    void endRemoveItems();
 
  protected:
    // populates the model
    void addRootItems();
    void removeRootItems();
 
    QVector<QgsCptCityDataItem *> mRootItems;
    QgsCptCityArchive *mArchive = nullptr;
    ViewType mViewType;
    QSize mIconSize;
};
 
// clazy:excludeall=qstring-allocations
 
#endif