qgslocatorwidget.h

Go to the documentation of this file.

/***************************************************************************
                         qgslocatorwidget.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 QGSLOCATORWIDGET_H
#define QGSLOCATORWIDGET_H
 
#include "qgis_gui.h"
#include "qgsfilterlineedit.h"
#include "qgsfloatingwidget.h"
#include "qgslocatorfilter.h"
#include "qgssettingstree.h"
 
#include <QFocusEvent>
#include <QHeaderView>
#include <QString>
#include <QTimer>
#include <QTreeView>
#include <QWidget>
 
using namespace Qt::StringLiterals;
 
class QgsLocator;
class QgsLocatorResultsView;
class QgsMapCanvas;
class QgsLocatorModelBridge;
class QgsLocatorLineEdit;
class QgsSettingsEntryInteger;

class GUI_EXPORT QgsLocatorWidget : public QWidget
{
    Q_OBJECT
 
  public:
#ifndef SIP_RUN
 
    static inline QgsSettingsTreeNode *sTreeGuiLocator = QgsSettingsTree::sTreeGui->createChildNode( u"locator"_s );
    static const QgsSettingsEntryInteger *settingLocatorTreeHeight;
#endif

    QgsLocatorWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    QgsLocator *locator();

    void setMapCanvas( QgsMapCanvas *canvas );

    void setPlaceholderText( const QString &text );

    void setResultContainerAnchors( QgsFloatingWidget::AnchorPoint anchorPoint, QgsFloatingWidget::AnchorPoint anchorWidgetPoint );
 
  public slots:

    void search( const QString &string );

    void invalidateResults();
 
  signals:

    void configTriggered();
 
  protected:
    bool eventFilter( QObject *obj, QEvent *event ) override;
 
  private slots:
    void performSearch();
    void showList();
    void triggerSearchAndShowList();
    void configMenuAboutToShow();
    void scheduleDelayedPopup();
    void resultAdded();
    void showContextMenu( const QPoint &point );
    void selectionChanged( const QItemSelection &selected, const QItemSelection &deselected );
 
  private:
    QgsLocatorModelBridge *mModelBridge = nullptr;
    QgsLocatorLineEdit *mLineEdit = nullptr;
    QgsFloatingWidget *mResultsContainer = nullptr;
    QgsLocatorResultsView *mResultsView = nullptr;
    QgsMapCanvas *mMapCanvas = nullptr;
    QList<QMetaObject::Connection> mCanvasConnections;
    QMenu *mMenu = nullptr;
 
    QTimer mFocusTimer;
    QTimer mPopupTimer;
    bool mHasSelectedResult = false;
 
    void acceptCurrentEntry();
};
 
#ifndef SIP_RUN

 
class QgsLocatorFilterFilter : public QgsLocatorFilter
{
    Q_OBJECT
 
  public:
    QgsLocatorFilterFilter( QgsLocatorWidget *widget, QObject *parent = nullptr );
 
    QgsLocatorFilterFilter *clone() const override SIP_FACTORY;
    QgsLocatorFilter::Flags flags() const override;
 
    QString name() const override { return u"filters"_s; }
    QString displayName() const override { return QString(); }
    Priority priority() const override { return static_cast<QgsLocatorFilter::Priority>( -1 );  }
    void fetchResults( const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback ) override;
    void triggerResult( const QgsLocatorResult &result ) override;
 
  private:
    QgsLocatorWidget *mLocator = nullptr;
};

class GUI_EXPORT QgsLocatorResultsView : public QTreeView
{
    Q_OBJECT
 
  public:
    QgsLocatorResultsView( QWidget *parent = nullptr );

    void recalculateSize();

    void selectNextResult();

    void selectPreviousResult();
};
 

class QgsLocatorLineEdit : public QgsFilterLineEdit
{
    Q_OBJECT
  public:
    explicit QgsLocatorLineEdit( QgsLocatorWidget *locator, QWidget *parent = nullptr );

    bool performCompletion();
 
  protected:
    void paintEvent( QPaintEvent *event ) override;
 
  private:
    QgsLocatorWidget *mLocatorWidget = nullptr;
    QString mCompletionText = nullptr;
};

 
#endif
 
 
#endif // QGSLOCATORWIDGET_H