Class: QgsLocatorResult

class qgis.core.QgsLocatorResult

Bases: sip.wrapper

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

New in version 3.0.

QgsLocatorResult() Constructor for QgsLocatorResult.

QgsLocatorResult(filter: QgsLocatorFilter, displayString: str, userData: Any = None) Constructor for QgsLocatorResult.

QgsLocatorResult(QgsLocatorResult)

Methods

getUserData

Returns the userData.

Attributes

class ResultAction

Bases: sip.wrapper

Constructor for ResultAction

QgsLocatorResult.ResultAction(id: int, text: str, iconPath: str = ‘’) Constructor for ResultAction The id used to recognized the action when the result is triggered. It should be 0 or greater as otherwise, the result will be triggered normally.

QgsLocatorResult.ResultAction(QgsLocatorResult.ResultAction)

iconPath
id
text
actions
description
displayString
filter
getUserData(self) Any

Returns the userData.

New in version 3.18.

Return type:

Any

group
icon
score
userData