QGIS API Documentation  3.23.0-Master (dd0cd13a00)
Public Member Functions | Public Attributes | List of all members
QgsLocatorContext Class Reference

Encapsulates the properties relating to the context of a locator search. More...

#include <qgslocatorcontext.h>

Public Member Functions

 QgsLocatorContext ()=default
 Constructor for QgsLocatorContext. More...
 

Public Attributes

QgsRectangle targetExtent
 Map extent to target in results. More...
 
QgsCoordinateReferenceSystem targetExtentCrs
 Coordinate reference system for the map extent variable. More...
 
QgsCoordinateTransformContext transformContext
 Coordinate transform context, to use whenever performing coordinate transformations inside a locator. More...
 
bool usingPrefix = false
 Will be true if search is being conducted using a filter prefix. More...
 

Detailed Description

Encapsulates the properties relating to the context of a locator search.

Since
QGIS 3.0

Definition at line 32 of file qgslocatorcontext.h.

Constructor & Destructor Documentation

◆ QgsLocatorContext()

QgsLocatorContext::QgsLocatorContext ( )
default

Constructor for QgsLocatorContext.

Member Data Documentation

◆ targetExtent

QgsRectangle QgsLocatorContext::targetExtent

Map extent to target in results.

This can be used to prioritize searching for results close to the current map extent. The CRS for the extent is specified by targetExtentCrs.

See also
targetExtentCrs

Definition at line 47 of file qgslocatorcontext.h.

◆ targetExtentCrs

QgsCoordinateReferenceSystem QgsLocatorContext::targetExtentCrs

Coordinate reference system for the map extent variable.

See also
targetExtent

Definition at line 53 of file qgslocatorcontext.h.

◆ transformContext

QgsCoordinateTransformContext QgsLocatorContext::transformContext

Coordinate transform context, to use whenever performing coordinate transformations inside a locator.

Since
QGIS 3.16

Definition at line 61 of file qgslocatorcontext.h.

◆ usingPrefix

bool QgsLocatorContext::usingPrefix = false

Will be true if search is being conducted using a filter prefix.

Definition at line 66 of file qgslocatorcontext.h.


The documentation for this class was generated from the following file: