Class: QgsLocatorResult¶

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

class qgis.core.QgsLocatorResult[source]¶

Bases: object

__init__()

__init__(filter: QgsLocatorFilter | None, displayString: str | None, userData: Any = None)

Constructor for QgsLocatorResult.

Parameters:

filter (Optional[QgsLocatorFilter])
displayString (Optional[str])
userData (Any = None)

__init__(a0: QgsLocatorResult)

Parameters:: a0 (QgsLocatorResult)

class ResultAction¶

Bases: object

The ResultAction stores basic information for additional actions to be used in a locator widget for the result. They could be used in a context menu for instance.

Added in version 3.6.

iconPath¶

id¶

text¶

actions: List[QgsLocatorResult.ResultAction]¶

description: str¶

displayString: str¶

filter: QgsLocatorFilter¶

group: str¶

groupScore: float¶

icon: QIcon¶

score: float¶

setUserData(self, userData: Any)[source]¶

Set userData for the locator result

Added in version 3.34.

Parameters:: userData (Any)

property userData[source]¶

Returns the userData.

Added in version 3.18.

Return type:: Any