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

#include <qgslocatorfilter.h>

Classes
struct	ResultAction
	The ResultAction stores basic information for additional actions to be used in a locator widget for the result. More...

Public Member Functions
	QgsLocatorResult ()=default
	Constructor for QgsLocatorResult. More...

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

Public Attributes
QList< QgsLocatorResult::ResultAction >	actions
	Additional actions to be used in a locator widget for the given result. More...

QString	description
	Descriptive text for result. More...

QString	displayString
	String displayed for result. More...

QgsLocatorFilter *	filter = nullptr
	Filter from which the result was obtained. More...

QString	group = QString()
	Group the results by categories If left as empty string, this means that results are all shown without being grouped. More...

QIcon	icon
	Icon for result. More...

double	score = 0.5
	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 39 of file qgslocatorfilter.h.

Constructor & Destructor Documentation

◆ QgsLocatorResult() [1/2]

QgsLocatorResult::QgsLocatorResult ( )

default

Constructor for QgsLocatorResult.

◆ QgsLocatorResult() [2/2]

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

inline

Constructor for QgsLocatorResult.

Definition at line 51 of file qgslocatorfilter.h.

Member Data Documentation

◆ actions

QList<QgsLocatorResult::ResultAction> QgsLocatorResult::actions

Additional actions to be used in a locator widget for the given result.

They could be displayed in a context menu.

Since: QGIS 3.6

Definition at line 130 of file qgslocatorfilter.h.

◆ description

QString QgsLocatorResult::description

Descriptive text for result.

Definition at line 70 of file qgslocatorfilter.h.

◆ displayString

QString QgsLocatorResult::displayString

String displayed for result.

Definition at line 65 of file qgslocatorfilter.h.

◆ filter

QgsLocatorFilter* QgsLocatorResult::filter = nullptr

Filter from which the result was obtained.

This is automatically set.

Definition at line 60 of file qgslocatorfilter.h.

◆ group

QString QgsLocatorResult::group = QString()

Group the results by categories If left as empty string, this means that results are all shown without being grouped.

If a group is given, the results will be grouped by group under a header.

Note: This should be translated.

Since: QGIS 3.2

Definition at line 94 of file qgslocatorfilter.h.

◆ icon

QIcon QgsLocatorResult::icon

Icon for result.

Definition at line 80 of file qgslocatorfilter.h.

◆ score

double QgsLocatorResult::score = 0.5

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

Definition at line 85 of file qgslocatorfilter.h.

◆ userData

QVariant QgsLocatorResult::userData

Custom reference or other data set by the filter.

Definition at line 75 of file qgslocatorfilter.h.

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

/tmp/buildd/qgis-3.6.0+99unstable/src/core/locator/qgslocatorfilter.h

Classes

Public Member Functions

Public Attributes