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




class QgsGeocoderContext
{
%Docstring(signature="appended")
Encapsulates the context of a geocoding operation.

.. versionadded:: 3.18
%End

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

    QgsGeocoderContext( const QgsCoordinateTransformContext &transformContext );
%Docstring
Constructor for QgsGeocoderContext, with the specified ``transformContext``.
%End

    QgsCoordinateTransformContext transformContext() const;
%Docstring
Returns the coordinate transform context, which should be used whenever the
geocoder constructs a coordinate transform.

.. seealso:: :py:func:`setTransformContext`
%End

    void setTransformContext( const QgsCoordinateTransformContext &context );
%Docstring
Sets the coordinate transform ``context``, which should be used whenever the
geocoder constructs a coordinate transform.

.. seealso:: :py:func:`transformContext`
%End

    QgsGeometry areaOfInterest() const;
%Docstring
Returns the optional area of interest, which can be used to indicate the desired
geographic area where geocoding results are desired.

The area of interest can be a polygon geometry, in which case it represents the extent
to use for filtering candidate results, or a point geometry, in which case it represents
a "target point" for prioritizing closer results.

The coordinate reference system for the area of interest can be retrieved via
:py:func:`~QgsGeocoderContext.areaOfInterestCrs`.

.. seealso:: :py:func:`setAreaOfInterest`

.. seealso:: :py:func:`areaOfInterestCrs`
%End

    void setAreaOfInterest( const QgsGeometry &area );
%Docstring
Sets the optional ``area`` of interest, which can be used to indicate the desired
geographic area where geocoding results are desired.

The area of interest can be a polygon geometry, in which case it represents the extent
to use for filtering candidate results, or a point geometry, in which case it represents
a "target point" for prioritizing closer results.

The coordinate reference system for the area of interest can be set via
:py:func:`~QgsGeocoderContext.setAreaOfInterestCrs`.

.. seealso:: :py:func:`areaOfInterest`

.. seealso:: :py:func:`setAreaOfInterestCrs`
%End

    QgsCoordinateReferenceSystem areaOfInterestCrs() const;
%Docstring
Returns the coordinate reference system for the area of interest, which can be used to indicate the desired
geographic area where geocoding results are desired.

.. seealso:: :py:func:`areaOfInterest`

.. seealso:: :py:func:`setAreaOfInterestCrs`
%End

    void setAreaOfInterestCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the ``crs`` for the area of interest, which can be used to indicate the desired
geographic area where geocoding results are desired.

.. seealso:: :py:func:`areaOfInterestCrs`

.. seealso:: :py:func:`setAreaOfInterest`
%End

};

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