/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/analysis/geocoding/qgsgeocoder.h                                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/




class QgsGeocoderInterface
{
%Docstring
Interface for geocoders.

QgsGeocoderInterface implementations are able to take either a QgsFeature or a free-form string
and calculate the corresponding geometry of the feature.

.. versionadded:: 3.18
%End

%TypeHeaderCode
#include "qgsgeocoder.h"
%End
  public:

    enum class Flag
    {
      GeocodesStrings,
      GeocodesFeatures,
    };
    typedef QFlags<QgsGeocoderInterface::Flag> Flags;


    virtual ~QgsGeocoderInterface();

    virtual Flags flags() const = 0;
%Docstring
Returns the geocoder's capability flags.
%End

    virtual QList< QgsGeocoderResult > geocodeFeature( const QgsFeature &feature, const QgsGeocoderContext &context, QgsFeedback *feedback = 0 ) const;
%Docstring
Geocodes a ``feature``.

If implemented by the geocoder (i.e. :py:func:`~QgsGeocoderInterface.flags` returns the QgsGeocoderInterface.Flag.GeocodesFeatures flag), a list of matching results will be returned.

The optional ``feedback`` argument can be used to provider cancelation support.
%End

    virtual QgsFields appendedFields() const;
%Docstring
Returns a set of newly created fields which will be appended to existing features during the geocode
operation.

These fields will include any extra content returned by the geocoder, such as fields for accuracy of the
match or correct attribute values.
%End

    virtual QgsWkbTypes::Type wkbType() const;
%Docstring
Returns the WKB type of geometries returned by the geocoder.

If this is not known in advance then QgsWkbTypes.Unknown should be returned (e.g.
in the case that a geocoder may return different geometry types depending on the
quality of the match).
%End

    virtual QList< QgsGeocoderResult > geocodeString( const QString &string, const QgsGeocoderContext &context, QgsFeedback *feedback = 0 ) const;
%Docstring
Geocodes a ``string``.

If implemented by the geocoder (i.e. :py:func:`~QgsGeocoderInterface.flags` returns the QgsGeocoderInterface.Flag.GeocodesStrings flag), a list of matching results will be returned.

The optional ``feedback`` argument can be used to provider cancelation support.
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/analysis/geocoding/qgsgeocoder.h                                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/