SymbolStyleSearchResult Class

  • SymbolStyleSearchResult
  • class Esri::ArcGISRuntime::SymbolStyleSearchResult

    A search result object returned by symbol style. More...

    Header: #include <SymbolStyleSearchResult.h>
    Since: Esri::ArcGISRuntime 100.0

    Public Functions

    SymbolStyleSearchResult(const Esri::ArcGISRuntime::SymbolStyleSearchResult &other)
    SymbolStyleSearchResult(Esri::ArcGISRuntime::SymbolStyleSearchResult &&other)
    QString category() const
    QFuture<Esri::ArcGISRuntime::Symbol *> fetchSymbolAsync(QObject *parent)
    bool isEmpty() const
    QString key() const
    QString name() const
    QString symbolClass() const
    QStringList tags() const
    Esri::ArcGISRuntime::SymbolStyleSearchResult &operator=(const Esri::ArcGISRuntime::SymbolStyleSearchResult &other)
    Esri::ArcGISRuntime::SymbolStyleSearchResult &operator=(Esri::ArcGISRuntime::SymbolStyleSearchResult &&other)

    Detailed Description

    This object is returned by symbol style based on the search performed using search parameters. It contains the information related to name, tags, category, class type, and key associated to a symbol. It also returns the symbol.

    This object returns the results based on search performed in the symbol style using the search parameters. This returns the symbol and all the parameters associated to it.

    See also DictionarySymbolStyle, SymbolStyle, and SymbolStyleSearchParameters.

    Member Function Documentation


    Default constructor.

    Note: This is provided for convenience only. It will construct an empty object.

    SymbolStyleSearchResult::SymbolStyleSearchResult(const Esri::ArcGISRuntime::SymbolStyleSearchResult &other)

    Copy constructor from other SymbolStyleSearchResult.

    SymbolStyleSearchResult::SymbolStyleSearchResult(Esri::ArcGISRuntime::SymbolStyleSearchResult &&other)

    Move constructor from other SymbolStyleSearchResult.



    QString SymbolStyleSearchResult::category() const

    Returns the category of this item.

    [since Esri::ArcGISRuntime 200.2] QFuture<Esri::ArcGISRuntime::Symbol *> SymbolStyleSearchResult::fetchSymbolAsync(QObject *parent)

    Asynchronously returns a symbol from the search result with the specified parent.

    • parent - The parent to apply to the resulting Symbol for memory management.

    This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

    See Working with QFuture for further details.

    Note: The parent argument is not optional because this object is not a QObject, so cannot be the parent by default. If you pass nullptr then the result will have no parent and may leak if care is not taken to manage the lifetime.

    This function was introduced in Esri::ArcGISRuntime 200.2.

    bool SymbolStyleSearchResult::isEmpty() const

    Returns whether this SymbolStyleSearchResult is empty.

    QString SymbolStyleSearchResult::key() const

    Returns the key of this item.

    QString SymbolStyleSearchResult::name() const

    Returns the name of this item.

    QString SymbolStyleSearchResult::symbolClass() const

    Returns the symbol class of this item.

    QStringList SymbolStyleSearchResult::tags() const

    Returns a string list of all the associated tags with this item.

    Esri::ArcGISRuntime::SymbolStyleSearchResult &SymbolStyleSearchResult::operator=(const Esri::ArcGISRuntime::SymbolStyleSearchResult &other)

    Assignment operator from other SymbolStyleSearchResult.

    Esri::ArcGISRuntime::SymbolStyleSearchResult &SymbolStyleSearchResult::operator=(Esri::ArcGISRuntime::SymbolStyleSearchResult &&other)

    Move operator from other SymbolStyleSearchResult.

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