QgsLocatorResult class

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

Public types

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

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

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: 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.
QIcon icon: Icon for result.
double score: Match score, from 0 - 1, where 1 represents a perfect match.
QVariant userData: Custom reference or other data set by the filter.

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

They could be displayed in a context menu.

Filter from which the result was obtained.

This is automatically set.

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.