SearchSuggestion Class

  • SearchSuggestion
  • class Esri::ArcGISRuntime::Toolkit::SearchSuggestion

    Wraps a Esri::ArcGISRuntime::SuggestResult result for display. More...

    Header: #include <SearchSuggestion>
    Inherits: QObject

    Properties

    Public Functions

    SearchSuggestion(QObject *parent = nullptr)
    virtual ~SearchSuggestion() override
    QString displaySubtitle() const
    QString displayTitle() const
    bool isCollection() const
    QUrl markerImageUrl() const
    Esri::ArcGISRuntime::Toolkit::SearchSourceInterface *owningSource()
    void setDisplaySubtitle(QString displaySubtitle)
    void setOwningSource(Esri::ArcGISRuntime::Toolkit::SearchSourceInterface *owningSource)
    void setSuggestResult(Esri::ArcGISRuntime::SuggestResult suggestResult)
    const Esri::ArcGISRuntime::SuggestResult &suggestResult() const

    Signals

    Detailed Description

    Property Documentation

    collection : const bool

    Access functions:

    bool isCollection() const

    Notifier signal:

    displaySubtitle : QString

    Access functions:

    QString displaySubtitle() const
    void setDisplaySubtitle(QString displaySubtitle)

    Notifier signal:

    displayTitle : const QString

    Access functions:

    QString displayTitle() const

    Notifier signal:

    markerImageUrl : const QUrl

    Access functions:

    QUrl markerImageUrl() const

    Notifier signal:

    owningSource : SearchSourceInterface*

    Access functions:

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

    Notifier signal:

    Member Function Documentation

    SearchSuggestion::SearchSuggestion(QObject *parent = nullptr)

    Constructs a new SearchSuggestion object with a given parent.

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

    [signal] void SearchSuggestion::displaySubtitleChanged()

    Signal emitted when the displaySubtitle changes.

    Note: Notifier signal for property displaySubtitle.

    [signal] void SearchSuggestion::markerImageUrlChanged()

    Signal emitted when the markerImageUrlChanged changes.

    Note: Notifier signal for property markerImageUrl.

    [signal] void SearchSuggestion::owningSourceChanged()

    Signal emitted when the owningSource changes.

    Note: Notifier signal for property owningSource.

    [signal] void SearchSuggestion::suggestResultChanged()

    Signal emitted when the suggestResult changes.

    Note: Notifier signal for property collection. Notifier signal for property displayTitle.

    [override virtual] SearchSuggestion::~SearchSuggestion()

    Destructor.

    QString SearchSuggestion::displaySubtitle() const

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

    Note: Getter function for property displaySubtitle.

    See also setDisplaySubtitle().

    QString SearchSuggestion::displayTitle() const

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

    Note: Getter function for property displayTitle.

    bool SearchSuggestion::isCollection() const

    Returns true if the search from this suggestion should be treated like a collection search, false if the search would return a single result.

    This property should be used to display a different icon in the UI depending on if this is a category search (like 'Coffee', 'Pizza', or 'Starbucks') and false if it is a search for a specific result (e.g. '380 New York St. Redlands CA').

    Note: Getter function for property collection.

    QUrl SearchSuggestion::markerImageUrl() const

    Returns the marker that would be shown in the UI.

    Note: Getter function for property markerImageUrl.

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

    Returns pointer to the search source that created this result.

    Note: Getter function for property owningSource.

    See also setOwningSource().

    void SearchSuggestion::setDisplaySubtitle(QString displaySubtitle)

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

    Note: Setter function for property displaySubtitle.

    See also displaySubtitle().

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

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

    Note: Setter function for property owningSource.

    See also owningSource().

    void SearchSuggestion::setSuggestResult(Esri::ArcGISRuntime::SuggestResult suggestResult)

    Sets the underling Esri::ArcGISRuntime::SuggestResult to suggestResult.

    This will also update the isCollection and displayTitle properties.

    See also suggestResult().

    const Esri::ArcGISRuntime::SuggestResult &SearchSuggestion::suggestResult() const

    Returns the underling Esri::ArcGISRuntime::SuggestResult.

    See also setSuggestResult().

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