QGIS API Documentation  2.99.0-Master (9caa722)
Public Member Functions | Public Attributes | List of all members
QgsLocatorResult Class Reference

Encapsulates properties of an individual matching result found by a QgsLocatorFilter. More...

#include <qgslocatorfilter.h>

Public Member Functions

 QgsLocatorResult ()
 Constructor for QgsLocatorResult. More...
 
 QgsLocatorResult (QgsLocatorFilter *filter, const QString &displayString, const QVariant &userData=QVariant())
 Constructor for QgsLocatorResult. More...
 

Public Attributes

QString description
 Descriptive text for result. More...
 
QString displayString
 String displayed for result. More...
 
QgsLocatorFilterfilter = nullptr
 Filter from which the result was obtained. More...
 
QIcon icon
 Icon for result. More...
 
double score
 Match score, from 0 - 1, where 1 represents a perfect match. More...
 
QVariant userData
 Custom reference or other data set by the filter. More...
 

Detailed Description

Encapsulates properties of an individual matching result found by a QgsLocatorFilter.

Since
QGIS 3.0

Definition at line 37 of file qgslocatorfilter.h.

Constructor & Destructor Documentation

◆ QgsLocatorResult() [1/2]

QgsLocatorResult::QgsLocatorResult ( )
inline

Constructor for QgsLocatorResult.

Definition at line 44 of file qgslocatorfilter.h.

◆ QgsLocatorResult() [2/2]

QgsLocatorResult::QgsLocatorResult ( QgsLocatorFilter filter,
const QString &  displayString,
const QVariant &  userData = QVariant() 
)
inline

Constructor for QgsLocatorResult.

Definition at line 52 of file qgslocatorfilter.h.

Member Data Documentation

◆ description

QString QgsLocatorResult::description

Descriptive text for result.

Definition at line 72 of file qgslocatorfilter.h.

◆ displayString

QString QgsLocatorResult::displayString

String displayed for result.

Definition at line 67 of file qgslocatorfilter.h.

◆ filter

QgsLocatorFilter* QgsLocatorResult::filter = nullptr

Filter from which the result was obtained.

Definition at line 62 of file qgslocatorfilter.h.

◆ icon

QIcon QgsLocatorResult::icon

Icon for result.

Definition at line 82 of file qgslocatorfilter.h.

◆ score

double QgsLocatorResult::score

Match score, from 0 - 1, where 1 represents a perfect match.

Definition at line 87 of file qgslocatorfilter.h.

◆ userData

QVariant QgsLocatorResult::userData

Custom reference or other data set by the filter.

Definition at line 77 of file qgslocatorfilter.h.


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