SearchSourceInterface Class

  • SearchSourceInterface
  • class Esri::ArcGISRuntime::Toolkit::SearchSourceInterface

    Defines the contract for a search result provider. More...

    Header: #include <SearchSourceInterface>
    Inherits: QObject
    Inherited By:

    Esri::ArcGISRuntime::Toolkit::LocatorSearchSource

    Properties

    Public Functions

    SearchSourceInterface(QObject *parent = nullptr)
    virtual ~SearchSourceInterface() override
    QString displayName() const
    virtual int maximumResults() const = 0
    virtual int maximumSuggestions() const = 0
    virtual Esri::ArcGISRuntime::Point preferredSearchLocation() const = 0
    virtual void search(const Esri::ArcGISRuntime::SuggestResult &suggestion, Esri::ArcGISRuntime::Geometry area = Geometry{}) = 0
    virtual void search(const QString &query, Esri::ArcGISRuntime::Geometry area = Geometry{}) = 0
    void setDisplayName(QString displayName)
    virtual void setMaximumResults(int maximumResults) = 0
    virtual void setMaximumSuggestions(int maximumSuggestions) = 0
    virtual void setPreferredSearchLocation(Esri::ArcGISRuntime::Point preferredSearchLocation) = 0
    virtual Esri::ArcGISRuntime::SuggestListModel *suggestions() const = 0

    Signals

    void displayNameChanged()
    void searchCompleted(QList<Esri::ArcGISRuntime::Toolkit::SearchResult *> searchResults)

    Detailed Description

    Property Documentation

    displayName : QString

    Access functions:

    QString displayName() const
    void setDisplayName(QString displayName)

    Notifier signal:

    Member Function Documentation

    SearchSourceInterface::SearchSourceInterface(QObject *parent = nullptr)

    Constructs a new SearchSourceInterface object with a given parent.

    [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().

    [signal] void SearchSourceInterface::displayNameChanged()

    Signal emitted when the displayName changes.

    Note: Notifier signal for property displayName.

    [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().

    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.

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

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

    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.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.