qgslocatormodel.h

Go to the documentation of this file.

/***************************************************************************
                         qgslocatormodel.h
                         ------------------
    begin                : May 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson 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 QGSLOCATORMODEL_H
#define QGSLOCATORMODEL_H
 
#include "qgis_core.h"
#include "qgslocatorfilter.h"
 
#include <QAbstractListModel>
#include <QSet>
#include <QSortFilterProxyModel>
#include <QTimer>
 
class QgsLocator;
class QgsLocatorModel;
class QgsLocatorProxyModel;

class CORE_EXPORT QgsLocatorModel : public QAbstractTableModel
{
    Q_OBJECT
 
  public:
 
    static const int NoGroup = -1;
    static const int UnorderedGroup = 0;

    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsLocatorModel, Role ) : int
    {
      ResultData SIP_MONKEYPATCH_COMPAT_NAME(ResultDataRole) = Qt::UserRole + 1, 
      ResultType SIP_MONKEYPATCH_COMPAT_NAME(ResultTypeRole), 
      ResultFilterPriority SIP_MONKEYPATCH_COMPAT_NAME(ResultFilterPriorityRole), 
      ResultScore SIP_MONKEYPATCH_COMPAT_NAME(ResultScoreRole), 
      ResultFilterName SIP_MONKEYPATCH_COMPAT_NAME(ResultFilterNameRole), 
      ResultFilterGroupSorting SIP_MONKEYPATCH_COMPAT_NAME(ResultFilterGroupSortingRole), 
      ResultFilterGroupTitle, 
      ResultFilterGroupScore, 
      ResultActions SIP_MONKEYPATCH_COMPAT_NAME(ResultActionsRole), 
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    QgsLocatorModel( QObject *parent SIP_TRANSFERTHIS = nullptr );

    void clear();

    void deferredClear();
 
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    QHash<int, QByteArray> roleNames() const override;
 
  public slots:

    void addResult( const QgsLocatorResult &result );
 
  private:
 
    enum Column
    {
      Name = 0,
      Description
    };
 
 
    // sorting is made on these values!
    enum class EntryType : int
    {
      Filter = 0,
      Group = 1,
      Result = 2,
    };
 
    struct Entry
    {
      EntryType type = EntryType::Result;
      QgsLocatorResult result;
      QString filterTitle;
      QgsLocatorFilter *filter = nullptr;
      QString groupTitle = QString();
      double groupScore = UnorderedGroup;
    };
 
    QList<Entry> mResults;
    QSet<QString> mFoundResultsFromFilterNames;
    // maps locator with pair of group title and group score
    QMap<QgsLocatorFilter *, QList<std::pair<QString, double>>> mFoundResultsFilterGroups;
    bool mDeferredClear = false;
    QTimer mDeferredClearTimer;
};

class CORE_EXPORT QgsLocatorAutomaticModel : public QgsLocatorModel
{
    Q_OBJECT
 
  public:

    explicit QgsLocatorAutomaticModel( QgsLocator *locator SIP_TRANSFERTHIS );

    QgsLocator *locator();

    void search( const QString &string );

    virtual QgsLocatorContext createContext();
 
  private slots:
 
    void searchFinished();
 
  private:
 
    QgsLocator *mLocator = nullptr;
 
    QString mNextRequestedString;
    bool mHasQueuedRequest = false;
};

class CORE_EXPORT QgsLocatorProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:

    explicit QgsLocatorProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr );
    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;
};
 
#endif // QGSLOCATORMODEL_H