Skip To Content ArcGIS for Developers Sign In Dashboard

SymbolStyleSearchParameters Class

(Esri::ArcGISRuntime::SymbolStyleSearchParameters)

Search parameters used to search for symbols in a SymbolStyle. More...

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

Public Functions

SymbolStyleSearchParameters()
SymbolStyleSearchParameters(const SymbolStyleSearchParameters &other)
SymbolStyleSearchParameters(SymbolStyleSearchParameters &&other)
~SymbolStyleSearchParameters()
QStringList categories() const
bool isCategoriesStrictlyMatch() const
bool isEmpty() const
bool isKeysStrictlyMatch() const
bool isNamesStrictlyMatch() const
bool isSymbolClassesStrictlyMatch() const
bool isTagsStrictlyMatch() const
QStringList keys() const
QStringList names() const
void setCategories(const QStringList &categories)
void setCategoriesStrictlyMatch(bool strictlyMatch)
void setKeys(const QStringList &keys)
void setKeysStrictlyMatch(bool strictlyMatch)
void setNames(const QStringList &names)
void setNamesStrictlyMatch(bool strictlyMatch)
void setSymbolClasses(const QStringList &symbolClasses)
void setSymbolClassesStrictlyMatch(bool strictlyMatch)
void setTags(const QStringList &tags)
void setTagsStrictlyMatch(bool strictlyMatch)
QStringList symbolClasses() const
QStringList tags() const
SymbolStyleSearchParameters &operator=(const SymbolStyleSearchParameters &other)
SymbolStyleSearchParameters &operator=(SymbolStyleSearchParameters &&other)

Detailed Description

Search parameters used to search for symbols in a SymbolStyle.

SymbolStyleSearchParameters allow you to specify different parameters when searching a SymbolStyle with SymbolStyle::searchSymbols. For example, you may want to search for any symbols where the category is "2", the name contains "destroyed", and the tags contain "Protection Lines".

Note: Each parameter category uses the OR operator for searching. For example, if you specify "friendly" and "tank" in the tags string list, it will return results that either have "friendly" or "tank" in the tags. Conversely, each individual parameter category uses the AND operator. For example, if you add "friendly" to the tags string list, and "5" to the categories string list, it will only return features that are both "friendly" and in category 5.

Member Function Documentation

SymbolStyleSearchParameters::SymbolStyleSearchParameters()

Default constructor.

SymbolStyleSearchParameters::SymbolStyleSearchParameters(const SymbolStyleSearchParameters &other)

Copy constructor from other SymbolStyleSearchParameters.

SymbolStyleSearchParameters::SymbolStyleSearchParameters(SymbolStyleSearchParameters &&other)

Move constructor from other SymbolStyleSearchParameters.

SymbolStyleSearchParameters::~SymbolStyleSearchParameters()

Destructor.

QStringList SymbolStyleSearchParameters::categories() const

Returns the string list of categories in this SymbolStyleSearchParameters.

See also setCategories().

bool SymbolStyleSearchParameters::isCategoriesStrictlyMatch() const

Returns whether the category search should enforce a strictMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

bool SymbolStyleSearchParameters::isEmpty() const

Whether all the list attributes are empty.

Returns true if the lists for categories, keys, names, symbolClasses and tags are all empty. This does not consider any of the strictMatch getters.

bool SymbolStyleSearchParameters::isKeysStrictlyMatch() const

Returns whether the key search should enforce a strictMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

bool SymbolStyleSearchParameters::isNamesStrictlyMatch() const

Returns whether the name search should enforce a strictMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

bool SymbolStyleSearchParameters::isSymbolClassesStrictlyMatch() const

Returns whether the symbol classes search should enforce a strictMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

bool SymbolStyleSearchParameters::isTagsStrictlyMatch() const

Returns whether the tags search should enforce a strictMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

QStringList SymbolStyleSearchParameters::keys() const

Returns the string list of keys in this SymbolStyleSearchParameters.

See also setKeys().

QStringList SymbolStyleSearchParameters::names() const

Returns the string list of names in this SymbolStyleSearchParameters.

See also setNames().

void SymbolStyleSearchParameters::setCategories(const QStringList &categories)

Sets the string list of categories in this SymbolStyleSearchParameters.

For example, with mil2525d you may want to search for symbols where the categories are "Activities : Main Icon" or "Sea Surface : Main Icon".

See also categories().

void SymbolStyleSearchParameters::setCategoriesStrictlyMatch(bool strictlyMatch)

Sets whether the category search should enforce a strictlyMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

See also isCategoriesStrictlyMatch().

void SymbolStyleSearchParameters::setKeys(const QStringList &keys)

Sets the string list of keys in this SymbolStyleSearchParameters.

For example, with mil2525d you may want to search for symbols where the keys are "25272100" or "2_635_1c".

See also keys().

void SymbolStyleSearchParameters::setKeysStrictlyMatch(bool strictlyMatch)

Sets whether the key search should enforce a strictlyMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

See also isKeysStrictlyMatch().

void SymbolStyleSearchParameters::setNames(const QStringList &names)

Sets the string list of names in this SymbolStyleSearchParameters.

For example, with mil2525d you may want to search for symbols where the names are "Ship Propulsion : Nuclear Powered" or "Simulation : Friend : Air".

See also names().

void SymbolStyleSearchParameters::setNamesStrictlyMatch(bool strictlyMatch)

Sets whether the name search should enforce a strictlyMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

See also isNamesStrictlyMatch().

void SymbolStyleSearchParameters::setSymbolClasses(const QStringList &symbolClasses)

Sets the string list of symbolClasses in this SymbolStyleSearchParameters.

For example, with mil2525d you may want to search for symbols where the symbol classes are "3" (Point Symbol) or "7" (North Arrow).

See also symbolClasses().

void SymbolStyleSearchParameters::setSymbolClassesStrictlyMatch(bool strictlyMatch)

Sets whether the symbol classes search should enforce a strictlyMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

See also isSymbolClassesStrictlyMatch().

void SymbolStyleSearchParameters::setTags(const QStringList &tags)

Sets the string list of tags in this SymbolStyleSearchParameters.

For example, with mil2525d you may want to search for symbols where the tags include "Airspace Control Points" or "Meteorological - Oceanographic".

See also tags().

void SymbolStyleSearchParameters::setTagsStrictlyMatch(bool strictlyMatch)

Sets whether the tags search should enforce a strictlyMatch.

A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

See also isTagsStrictlyMatch().

QStringList SymbolStyleSearchParameters::symbolClasses() const

Returns the string list of symbol classes in this SymbolStyleSearchParameters.

See also setSymbolClasses().

QStringList SymbolStyleSearchParameters::tags() const

Returns the string list of tags in this SymbolStyleSearchParameters.

See also setTags().

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

Assignment operator from other SymbolStyleSearchParameters.

SymbolStyleSearchParameters &SymbolStyleSearchParameters::operator=(SymbolStyleSearchParameters &&other)

Move operator from other SymbolStyleSearchParameters.


Feedback on this topic?