Skip To Content ArcGIS for Developers Sign In Dashboard

SymbolStyleSearchResult Class

(Esri::ArcGISRuntime::SymbolStyleSearchResult)

The results from searching through a style file. More...

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

Public Functions

SymbolStyleSearchResult()
SymbolStyleSearchResult(const SymbolStyleSearchResult &other)
SymbolStyleSearchResult(SymbolStyleSearchResult &&other)
~SymbolStyleSearchResult()
QString category() const
bool isEmpty() const
QString key() const
QString name() const
Symbol *symbol(QObject *parent = nullptr) const
QString symbolClass() const
QStringList tags() const
SymbolStyleSearchResult &operator=(const SymbolStyleSearchResult &other)
SymbolStyleSearchResult &operator=(SymbolStyleSearchResult &&other)

Detailed Description

The results from searching through a style file.

For example, you can obtain a list model of SymbolStyleSearchResult objects from the SymbolStyle::searchSymbolsCompleted signal after calling the SymbolStyle::searchSymbols asynchronous task. The list model can either be used in a view to display several results in a UI, or each result can be accessed individually. Each object represents a row in the associated *.stylx file. You will be able to access that individual row's symbol, name, category, keys, classes, and associated tags.

Member Function Documentation

SymbolStyleSearchResult::SymbolStyleSearchResult()

Default constructor.

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

SymbolStyleSearchResult::SymbolStyleSearchResult(const SymbolStyleSearchResult &other)

Copy constructor from other SymbolStyleSearchResult.

SymbolStyleSearchResult::SymbolStyleSearchResult(SymbolStyleSearchResult &&other)

Move constructor from other SymbolStyleSearchResult.

SymbolStyleSearchResult::~SymbolStyleSearchResult()

Destructor.

QString SymbolStyleSearchResult::category() const

Returns the category of this item.

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.

Symbol *SymbolStyleSearchResult::symbol(QObject *parent = nullptr) const

Returns the symbol of this item, with an optional parent.

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.

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

Assignment operator from other SymbolStyleSearchResult.

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

Move operator from other SymbolStyleSearchResult.


Feedback on this topic?