Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgslocatorcontext.h
       3                 :            :                          ------------------
       4                 :            :     begin                : May 2017
       5                 :            :     copyright            : (C) 2017 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSLOCATORCONTEXT_H
      19                 :            : #define QGSLOCATORCONTEXT_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgsrectangle.h"
      23                 :            : #include "qgscoordinatereferencesystem.h"
      24                 :            : #include "qgscoordinatetransformcontext.h"
      25                 :            : 
      26                 :            : /**
      27                 :            :  * \class QgsLocatorContext
      28                 :            :  * \ingroup core
      29                 :            :  * \brief Encapsulates the properties relating to the context of a locator search.
      30                 :            :  * \since QGIS 3.0
      31                 :            :  */
      32                 :          0 : class CORE_EXPORT QgsLocatorContext
      33                 :            : {
      34                 :            :   public:
      35                 :            : 
      36                 :            :     /**
      37                 :            :      * Constructor for QgsLocatorContext.
      38                 :            :      */
      39                 :          0 :     QgsLocatorContext() = default;
      40                 :            : 
      41                 :            :     /**
      42                 :            :      * Map extent to target in results. This can be used to prioritize searching
      43                 :            :      * for results close to the current map extent. The CRS for the extent
      44                 :            :      * is specified by targetExtentCrs.
      45                 :            :      * \see targetExtentCrs
      46                 :            :      */
      47                 :            :     QgsRectangle targetExtent;
      48                 :            : 
      49                 :            :     /**
      50                 :            :      * Coordinate reference system for the map extent variable.
      51                 :            :      * \see targetExtent
      52                 :            :      */
      53                 :            :     QgsCoordinateReferenceSystem targetExtentCrs;
      54                 :            : 
      55                 :            :     /**
      56                 :            :      * Coordinate transform context, to use whenever performing coordinate transformations inside
      57                 :            :      * a locator.
      58                 :            :      *
      59                 :            :      * \since QGIS 3.16
      60                 :            :      */
      61                 :            :     QgsCoordinateTransformContext transformContext;
      62                 :            : 
      63                 :            :     /**
      64                 :            :      * Will be TRUE if search is being conducted using a filter prefix.
      65                 :            :      */
      66                 :          0 :     bool usingPrefix = false;
      67                 :            : 
      68                 :            : };
      69                 :            : 
      70                 :            : #endif // QGSLOCATORCONTEXT_H
      71                 :            : 
      72                 :            :