SearchSourceInterface Class

Member Function Documentation

SearchSourceInterface::SearchSourceInterface(QObject *parent = nullptr)

Constructs a new SearchSourceInterface object with a given parent.

[signal] void SearchSourceInterface::displayNameChanged()

Signal emitted when the displayName changes.

Note: Notifier signal for property displayName.

[signal] void SearchSourceInterface::searchCompleted(QList<Esri::ArcGISRuntime::Toolkit::SearchResult *> searchResults)

Signal emitted when the search completes, giving the found search results as searchResults.

[override virtual] SearchSourceInterface::~SearchSourceInterface()

Destructor.

QString SearchSourceInterface::displayName() const

Returns the name to show when presenting this source in the UI.

Note: Getter function for property displayName.

See also setDisplayName().

[pure virtual] int SearchSourceInterface::maximumResults() const

Returns the maximum results to return when performing a search.

Most sources default to 6.

See also setMaximumResults().

[pure virtual] int SearchSourceInterface::maximumSuggestions() const

Returns the maximum suggestions to return when performing a search.

Most sources default to 6.

See also setMaximumSuggestions().

[pure virtual] Esri::ArcGISRuntime::Point SearchSourceInterface::preferredSearchLocation() const

Returns the point to be used as an input to searches and suggestions.

See also setPreferredSearchLocation().

[pure virtual] void SearchSourceInterface::search(const Esri::ArcGISRuntime::SuggestResult &suggestion, Esri::ArcGISRuntime::Geometry area = Geometry{})

Gets search results using suggestion as input.

If area is not default constructed, search is restricted to that area.

[pure virtual] void SearchSourceInterface::search(const QString &query, Esri::ArcGISRuntime::Geometry area = Geometry{})

Gets search results using query as input.

If area is not default constructed, search is restricted to that area.

void SearchSourceInterface::setDisplayName(QString displayName)

Sets the name to show when presenting this source in the UI to displayName.

Note: Setter function for property displayName.

See also displayName().

[pure virtual] void SearchSourceInterface::setMaximumResults(int maximumResults)

Sets the maximum results to return when performing a search to maximumResults.

See also maximumResults().

[pure virtual] void SearchSourceInterface::setMaximumSuggestions(int maximumSuggestions)

Sets the maximum suggestions to return when performing a search to maximumSuggestions.

See also maximumSuggestions().

[pure virtual] void SearchSourceInterface::setPreferredSearchLocation(Esri::ArcGISRuntime::Point preferredSearchLocation)

Sets the point to be used as an input to searches and suggestions to preferredSearchLocation.

See also preferredSearchLocation().

[pure virtual] Esri::ArcGISRuntime::SuggestListModel *SearchSourceInterface::suggestions() const

Returns suggestions.