qgsgeocoder.h

Go to the documentation of this file.

/***************************************************************************
  qgsgeocoder.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 QGSGEOCODER_H
#define QGSGEOCODER_H
 
#include "qgis_core.h"
#include "qgsfields.h"
#include "qgsgeocoderresult.h"
#include "qgsgeometry.h"
 
class QgsFeature;
class QgsGeocoderContext;

class CORE_EXPORT QgsGeocoderInterface
{
 
  public:

    enum class Flag SIP_ENUM_BASETYPE( IntFlag )
    {
      GeocodesStrings = 1 << 0, 
      GeocodesFeatures = 1 << 1, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    virtual ~QgsGeocoderInterface() = default;

    virtual Flags flags() const = 0;

    virtual QList< QgsGeocoderResult > geocodeFeature( const QgsFeature &feature, const QgsGeocoderContext &context, QgsFeedback *feedback = nullptr ) const;

    virtual QgsFields appendedFields() const;

    virtual Qgis::WkbType wkbType() const;

    virtual QList< QgsGeocoderResult > geocodeString( const QString &string, const QgsGeocoderContext &context, QgsFeedback *feedback = nullptr ) const;
 
};
 
#endif // QGSGEOCODER_H