SearchResult Class

Member Function Documentation

[invokable] SearchResult::SearchResult(QObject *parent = nullptr)

Constructs a new SearchResult object with a given parent.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[override virtual] SearchResult::~SearchResult()

Destructor.

QString SearchResult::displaySubtitle() const

Returns the optional subtitle that should be shown whenever a result is displayed.

Note: Getter function for property displaySubtitle.

See also setDisplaySubtitle().

[signal] void SearchResult::displaySubtitleChanged()

Signal emitted when the displaySubtitle changes.

Note: Notifier signal for property displaySubtitle.

QString SearchResult::displayTitle() const

Returns the title that should be shown whenever a result is displayed.

Note: Getter function for property displayTitle.

See also setDisplayTitle().

[signal] void SearchResult::displayTitleChanged()

Signal emitted when the displayTitleChanged changes.

Note: Notifier signal for property displayTitle.

Esri::ArcGISRuntime::GeoElement *SearchResult::geoElement() const

Returns the geo-element.

For locator results, should be the graphic that was used to display the result on the map. For feature layer results, should be the result feature. Can be null depending on the type of the result, and can have GeoElements without a defined geometry.

See also setGeoElement().

[signal] void SearchResult::geoElementChanged()

Signal emitted when the geoElement changes.

QUrl SearchResult::markerImageUrl() const

Returns the marker that would be shown on the map. This property is available as a convenience such that consumers need not worry whether the Esri::ArcGISRuntime::GeoElement is a graphic or a feature when displaying the icon in the UI.

Note: Getter function for property markerImageUrl.

See also setMarkerImageUrl().

[signal] void SearchResult::markerImageUrlChanged()

Signal emitted when the markerImageUrlChanged changes.

Note: Notifier signal for property markerImageUrl.

Esri::ArcGISRuntime::Toolkit::SearchSourceInterface *SearchResult::owningSource()

Returns pointer to the search source that created this result.

Note: Getter function for property owningSource.

See also setOwningSource().

[signal] void SearchResult::owningSourceChanged()

Signal emitted when the owningSource changes.

Note: Notifier signal for property owningSource.

Esri::ArcGISRuntime::Viewpoint SearchResult::selectionViewpoint() const

Returns the viewpoint to be used when the view zooms to a selected result.

This property can be default-constructed because not all valid results will have a geometry. E.g. feature results from non-spatial features.

See also setSelectionViewpoint().

[signal] void SearchResult::selectionViewpointChanged()

Signal emitted when the selectionViewpoint changes.

void SearchResult::setDisplaySubtitle(QString displaySubtitle)

Sets the optional subtitle that should be shown whenever a result is displayed to displaySubtitle.

Note: Setter function for property displaySubtitle.

See also displaySubtitle().

void SearchResult::setDisplayTitle(QString displayTitle)

Sets the title that should be shown whenever a result is displayed to displayTitle.

Note: Setter function for property displayTitle.

See also displayTitle().

void SearchResult::setGeoElement(Esri::ArcGISRuntime::GeoElement *geoElement)

Sets the geo-element to geoElement.

See also geoElement().

void SearchResult::setMarkerImageUrl(QUrl markerImageUrl)

Sets the marker that would be shown on the map to the image located at markerImageUrl. This property is available as a convenience. Calling this setter after construction will not update the geoElement image automatically.

Note: Setter function for property markerImageUrl.

See also markerImageUrl().

void SearchResult::setOwningSource(Esri::ArcGISRuntime::Toolkit::SearchSourceInterface *owningSource)

Sets the pointer to the search source owningSource that created this result.

Note: Setter function for property owningSource.

See also owningSource().

void SearchResult::setSelectionViewpoint(Esri::ArcGISRuntime::Viewpoint selectionViewpoint)

Sets the viewpoint to be used when the view zooms to a selected result to selectionViewpoint.

See also selectionViewpoint().