Qt 5.6 | Qt Location | C++ Classes | QPlaceCategory

Qt 5.6.3 Reference Documentation

# QPlaceCategory Class

The QPlaceCategory class represents a category that a QPlace can be associated with. More...

Header: | #include <QPlaceCategory>
qmake: | QT += location
Since: | Qt 5.6

- List of all members, including inherited members

## Public Functions

| QPlaceCategory()
| QPlaceCategory(const QPlaceCategory &other)
virtual | ~QPlaceCategory()
QString | categoryId() const
QPlaceIcon | icon() const
bool | isEmpty() const
QString | name() const
void | setCategoryId(const QString &identifier)
void | setIcon(const QPlaceIcon &icon)
void | setName(const QString &name)
void | setVisibility(QLocation::Visibility visibility)
QLocation::Visibility | visibility() const
bool | operator!=(const QPlaceCategory &other) const
QPlaceCategory & | operator=(const QPlaceCategory &other)
bool | operator==(const QPlaceCategory &other) const

## Detailed Description

The QPlaceCategory class represents a category that a QPlace can be associated with.

Categories are used to search for places based on the categories they are associated with. The list/tree of available categories can be obtained from QPlaceManager. The QPlaceSearchRequest::setCategories() function can be used to limit the search results to places with the specified categories.

If the QGeoServiceProvider supports it, categories can be created and removed. This functionality is available in the QPlaceManager class.

## Member Function Documentation

### QPlaceCategory::QPlaceCategory()

Constructs a category.

### QPlaceCategory::QPlaceCategory(const QPlaceCategory &other)

Constructs a category which is a copy of other.

### `[virtual]` QPlaceCategory::~QPlaceCategory()

Destroys the category.

### QString QPlaceCategory::categoryId() const

Returns the identifier of the category. The category identifier is a string which uniquely identifies this category within a particular QPlaceManager. The identifier is only meaningful to the QPlaceManager that generated it and is not transferable between managers.

See also setCategoryId().

### QPlaceIcon QPlaceCategory::icon() const

Returns the icon associated with the category.

See also setIcon().

### bool QPlaceCategory::isEmpty() const

Returns a boolean indicating whether the all the fields of the place category are empty or not.

### QString QPlaceCategory::name() const

Returns the name of category.

See also setName().

### void QPlaceCategory::setCategoryId(const QString &identifier)

Sets the identifier of the category.

See also categoryId().

### void QPlaceCategory::setIcon(const QPlaceIcon &icon)

Sets the icon of the category.

See also icon().

### void QPlaceCategory::setName(const QString &name)

Sets the name of the category.

See also name().

### void QPlaceCategory::setVisibility(QLocation::Visibility visibility)

Sets the visibility of the category.

See also visibility().

### QLocation::Visibility QPlaceCategory::visibility() const

Returns the visibility of the category.

See also setVisibility().

### bool QPlaceCategory::operator!=(const QPlaceCategory &other) const

Returns true if other is not equal to this category; otherwise returns false.

### QPlaceCategory &QPlaceCategory::operator=(const QPlaceCategory &other)

Assigns other to this category and returns a reference to this category.

### bool QPlaceCategory::operator==(const QPlaceCategory &other) const

Returns true if other is equal to this category; otherwise returns false.