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

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...

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.

Definition at line 31 of file qgslocatorcontext.h.

Constructor & Destructor Documentation

QgsLocatorContext::QgsLocatorContext ( )

default

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.

Definition at line 46 of file qgslocatorcontext.h.

QgsCoordinateReferenceSystem QgsLocatorContext::targetExtentCrs

Coordinate reference system for the map extent variable.

Definition at line 52 of file qgslocatorcontext.h.

bool QgsLocatorContext::usingPrefix = false

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

Definition at line 57 of file qgslocatorcontext.h.

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