Uses a Locator to provide search and suggest results. More...
| Header: | #include <LocatorSearchSource> |
| Inherits: | Esri::ArcGISRuntime::Toolkit::SearchSourceInterface |
| Inherited By: |
Public Functions
| LocatorSearchSource(Esri::ArcGISRuntime::LocatorTask *locatorTask, QObject *parent = nullptr) | |
| virtual | ~LocatorSearchSource() override |
| Esri::ArcGISRuntime::GeocodeParameters | geocodeParameters() const |
| Esri::ArcGISRuntime::LocatorTask * | locator() |
| Esri::ArcGISRuntime::SuggestParameters | suggestParameters() const |
Reimplemented Public Functions
| virtual int | maximumResults() const override |
| virtual int | maximumSuggestions() const override |
| virtual Esri::ArcGISRuntime::Point | preferredSearchLocation() const override |
| virtual void | search(const Esri::ArcGISRuntime::SuggestResult &suggestion, Esri::ArcGISRuntime::Geometry area = Geometry{}) override |
| virtual void | setMaximumResults(int maximumResults) override |
| virtual void | setMaximumSuggestions(int maximumSuggestions) override |
| virtual void | setPreferredSearchLocation(Esri::ArcGISRuntime::Point preferredSearchLocation) override |
Detailed Description
Note: Most configuration should be done on the GeocodeParameters directly.
Member Function Documentation
LocatorSearchSource::LocatorSearchSource (Esri::ArcGISRuntime::LocatorTask *locatorTask , QObject *parent = nullptr)
Constructs a new LocatorSearchSource object with a locatorTask and a given parent.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[override virtual] LocatorSearchSource::~LocatorSearchSource ()
Destructor.
Esri::ArcGISRuntime::GeocodeParameters LocatorSearchSource::geocodeParameters () const
Returns the parameters used for geocoding. Some properties on parameters will be updated automatically based on searches.
Esri::ArcGISRuntime::LocatorTask *LocatorSearchSource::locator()
Returns the locator used by this search source.
[override virtual] int LocatorSearchSource::maximumResults () const
Reimplements: SearchSourceInterface::maximumResults() const.
See also setMaximumResults().
[override virtual] int LocatorSearchSource::maximumSuggestions () const
Reimplements: SearchSourceInterface::maximumSuggestions() const.
See also setMaximumSuggestions().
[override virtual] Esri::ArcGISRuntime::Point LocatorSearchSource::preferredSearchLocation () const
Reimplements: SearchSourceInterface::preferredSearchLocation() const.
See also setPreferredSearchLocation().
[override virtual] void LocatorSearchSource::search(const Esri::ArcGISRuntime::SuggestResult &suggestion, Esri::ArcGISRuntime::Geometry area = Geometry{})
Reimplements: SearchSourceInterface::search(const Esri::ArcGISRuntime::SuggestResult &suggestion, Esri::ArcGISRuntime::Geometry area).
[override virtual] void LocatorSearchSource::setMaximumResults (int maximumResults )
Reimplements: SearchSourceInterface::setMaximumResults(int maximumResults).
See also maximumResults().
[override virtual] void LocatorSearchSource::setMaximumSuggestions (int maximumSuggestions )
Reimplements: SearchSourceInterface::setMaximumSuggestions(int maximumSuggestions).
See also maximumSuggestions().
[override virtual] void LocatorSearchSource::setPreferredSearchLocation (Esri::ArcGISRuntime::Point preferredSearchLocation )
Reimplements: SearchSourceInterface::setPreferredSearchLocation(Esri::ArcGISRuntime::Point preferredSearchLocation).
See also preferredSearchLocation().
Esri::ArcGISRuntime::SuggestParameters LocatorSearchSource::suggestParameters () const
Returns the parameters used for suggestions. Some properties on parameters will be updated automatically based on searches.