qgsabstractgeocoderlocatorfilter.h

Go to the documentation of this file.

/***************************************************************************
  qgsabstractgeocoderlocatorfilter.h
  ---------------
  Date                 : August 2020
  Copyright            : (C) 2020 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 QGSABSTRACTGEOCODERLOCATORFILTER_H
#define QGSABSTRACTGEOCODERLOCATORFILTER_H
 
#include "qgis_core.h"
#include "qgslocatorfilter.h"
 
class QgsGeocoderInterface;
class QgsGeocoderResult;

class CORE_EXPORT QgsAbstractGeocoderLocatorFilter : public QgsLocatorFilter SIP_ABSTRACT
{
    Q_OBJECT
 
  public:

    QgsAbstractGeocoderLocatorFilter( const QString &name, const QString &displayName,
                                      const QString &prefix,
                                      QgsGeocoderInterface *geocoder,
                                      const QgsRectangle &boundingBox = QgsRectangle() );
 
    QString name() const override;
    QString displayName() const override;
    QString prefix() const override;
    void fetchResults( const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback ) override;
    void triggerResult( const QgsLocatorResult &result ) override;

    QgsGeocoderInterface *geocoder() const;

    const QgsRectangle boundingBox() { return mBoundingBox; }

    QgsGeocoderResult locatorResultToGeocoderResult( const QgsLocatorResult &result ) const;

    QgsLocatorResult geocoderResultToLocatorResult( const QgsGeocoderResult &result );
 
  private:

    virtual void handleGeocodeResult( const QgsGeocoderResult &result ) = 0;
 
    QString mName;
    QString mDisplayName;
    QString mPrefix;
    QgsGeocoderInterface *mGeocoder = nullptr;
    QgsRectangle mBoundingBox;
 
};
 
#endif // QGSABSTRACTGEOCODERLOCATORFILTER_H