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

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

void	setUserData (const QVariant &userData)
	Set userData for the locator result.

QVariant	userData () const
	Returns the `userData`.

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

QString	description
	Descriptive text for result.

QString	displayString
	String displayed for result.

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

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

double	groupScore = 0
	Specifies the score of the group to allow ordering.

QIcon	icon
	Icon for result.

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

Detailed Description

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

Definition at line 37 of file qgslocatorfilter.h.

Constructor & Destructor Documentation

◆ QgsLocatorResult() [1/2]

QgsLocatorResult::QgsLocatorResult ( )

default

◆ QgsLocatorResult() [2/2]

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

inline

Constructor for QgsLocatorResult.

Definition at line 46 of file qgslocatorfilter.h.

Member Function Documentation

◆ setUserData()

void QgsLocatorResult::setUserData ( const QVariant & userData )

Set userData for the locator result.

Since: QGIS 3.34

Definition at line 109 of file qgslocatorfilter.cpp.

◆ userData()

QVariant QgsLocatorResult::userData ( ) const

Returns the userData.

Since: QGIS 3.18

Definition at line 104 of file qgslocatorfilter.cpp.

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 143 of file qgslocatorfilter.h.

◆ description

QString QgsLocatorResult::description

Descriptive text for result.

Definition at line 79 of file qgslocatorfilter.h.

◆ displayString

QString QgsLocatorResult::displayString

String displayed for result.

Definition at line 74 of file qgslocatorfilter.h.

◆ filter

QgsLocatorFilter* QgsLocatorResult::filter = nullptr

Filter from which the result was obtained.

This is automatically set.

Definition at line 69 of file qgslocatorfilter.h.

◆ group

QString QgsLocatorResult::group

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 98 of file qgslocatorfilter.h.

◆ groupScore

double QgsLocatorResult::groupScore = 0

Specifies the score of the group to allow ordering.

Score must be positive, higher scores are shown first. If the scores are left to 0 or are identical, the sorting of groups is made alphabetically.

Since: QGIS 3.40

Definition at line 107 of file qgslocatorfilter.h.

◆ icon

QIcon QgsLocatorResult::icon

Icon for result.

Definition at line 84 of file qgslocatorfilter.h.

◆ score

double QgsLocatorResult::score = 0.5

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

Definition at line 89 of file qgslocatorfilter.h.

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

/build/qgis-3.40.0+99sid/src/core/locator/qgslocatorfilter.h
/build/qgis-3.40.0+99sid/src/core/locator/qgslocatorfilter.cpp

Classes

Public Member Functions

Public Attributes