qgsbrowsermodel.h

Go to the documentation of this file.

/***************************************************************************
    qgsbrowsermodel.h
    ---------------------
    begin                : July 2011
    copyright            : (C) 2011 by Martin Dobias
    email                : wonder dot sk at gmail dot 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 QGSBROWSERMODEL_H
#define QGSBROWSERMODEL_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QAbstractItemModel>
#include <QIcon>
#include <QMimeData>
#include <QMovie>
 
class QgsDataItem;
class QgsDataItemProvider;
class QgsDirectoryItem;
class QgsFavoriteItem;
class QgsFavoritesItem;

class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    explicit QgsBrowserModel( QObject *parent = nullptr );
 
    ~QgsBrowserModel() override;
 
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsBrowserModel, ItemDataRole ) : int
    {
      Path SIP_MONKEYPATCH_COMPAT_NAME( PathRole ) = Qt::UserRole,           
      Comment SIP_MONKEYPATCH_COMPAT_NAME( CommentRole ) = Qt::UserRole + 1, 
      Sort SIP_MONKEYPATCH_COMPAT_NAME( SortRole ),                          
      ProviderKey SIP_MONKEYPATCH_COMPAT_NAME( ProviderKeyRole ),            
      LayerMetadata SIP_MONKEYPATCH_COMPAT_NAME( LayerMetadataRole ),        
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    // 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;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) 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 parent( const QModelIndex &index ) const override;
    QStringList mimeTypes() const override;
    QMimeData *mimeData( const QModelIndexList &indexes ) const override;
    bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ) override;
    bool hasChildren( const QModelIndex &parent = QModelIndex() ) const override;
    bool canFetchMore( const QModelIndex &parent ) const override;
    void fetchMore( const QModelIndex &parent ) override;

    QModelIndex findItem( QgsDataItem *item, QgsDataItem *parent = nullptr ) const;

    QgsDataItem *dataItem( const QModelIndex &idx ) const;

    void refresh( const QString &path );

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

    QModelIndex findPath( const QString &path, Qt::MatchFlag matchFlag = Qt::MatchExactly );

    static QModelIndex findPath( QAbstractItemModel *model, const QString &path, Qt::MatchFlag matchFlag = Qt::MatchExactly ) SIP_SKIP;

    QModelIndex findUri( const QString &uri, QModelIndex index = QModelIndex() );

    Q_DECL_DEPRECATED void connectItem( QgsDataItem *item ) SIP_DEPRECATED;

    bool initialized() const { return mInitialized; }

    QMap<QString, QgsDirectoryItem *> driveItems() const;

    QVector<QgsDataItem *> rootItems() const { return mRootItems; }
 
  signals:

    void stateChanged( const QModelIndex &index, Qgis::BrowserItemState oldState );

    void connectionsChanged( const QString &providerKey );
 
  public slots:
    void reload();

    void refreshDrives();
 
    void beginInsertItems( QgsDataItem *parent, int first, int last );
    void endInsertItems();
    void beginRemoveItems( QgsDataItem *parent, int first, int last );
    void endRemoveItems();
    void itemDataChanged( QgsDataItem *item );

    void itemStateChanged( QgsDataItem *item, Qgis::BrowserItemState oldState );

    void addFavoriteDirectory( const QString &directory, const QString &name = QString() );

    void removeFavorite( const QModelIndex &index );

    void removeFavorite( QgsFavoriteItem *favorite ) SIP_SKIP;
 
    void updateProjectHome();

    void hidePath( QgsDataItem *item );

    void initialize();
 
  protected:
    void addRootItems();
    void removeRootItems();
 
    QVector<QgsDataItem *> mRootItems;
    QgsFavoritesItem *mFavorites = nullptr;
    QgsDirectoryItem *mProjectHome = nullptr;
 
  private slots:
    void dataItemProviderAdded( QgsDataItemProvider *provider );
    void dataItemProviderWillBeRemoved( QgsDataItemProvider *provider );
    void onConnectionsChanged( const QString &providerKey );
 
  private:
    bool mInitialized = false;
    QMap< QString, QgsDirectoryItem * > mDriveItems;
 
    void setupItemConnections( QgsDataItem *item );
 
    void removeRootItem( QgsDataItem *item );
 
    QgsDataItem *addProviderRootItem( QgsDataItemProvider *provider );
 
    friend class TestQgsBrowserModel;
    friend class TestQgsBrowserProxyModel;
};
 
#endif // QGSBROWSERMODEL_H