\inmodule QtLocation More...

#include <qplacecategory.h>

Collaboration diagram for QPlaceCategory:

Public Member Functions
	QPlaceCategory ()
	Constructs a category.

	QPlaceCategory (const QPlaceCategory &other) noexcept
	Constructs a category which is a copy of other.

	QPlaceCategory (QPlaceCategory &&other) noexcept=default

	~QPlaceCategory ()
	Destroys the category.

QPlaceCategory &	operator= (const QPlaceCategory &other) noexcept
	Assigns other to this category and returns a reference to this category.

void	swap (QPlaceCategory &other) noexcept

QString	categoryId () const
	Returns the identifier of the category.

void	setCategoryId (const QString &identifier)
	Sets the identifier of the category.

QString	name () const
	Returns the name of category.

void	setName (const QString &name)
	Sets the name of the category.

QLocation::Visibility	visibility () const
	Returns the visibility of the category.

void	setVisibility (QLocation::Visibility visibility)
	Sets the visibility of the category.

QPlaceIcon	icon () const
	Returns the icon associated with the category.

void	setIcon (const QPlaceIcon &icon)
	Sets the icon of the category.

bool	isEmpty () const
	Returns a boolean indicating whether the all the fields of the place category are empty or not.

Friends
bool	operator== (const QPlaceCategory &lhs, const QPlaceCategory &rhs) noexcept
	Returns true if lhs is equal to rhs; otherwise returns false.

bool	operator!= (const QPlaceCategory &lhs, const QPlaceCategory &rhs) noexcept
	Returns true if lhs is not equal to rhs; otherwise returns false.

Detailed Description

\inmodule QtLocation

Since: 5.6

The QPlaceCategory class represents a category that a \l 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 \l QPlaceManager. The \l QPlaceSearchRequest::setCategories() function can be used to limit the search results to places with the specified categories.

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

Definition at line 21 of file qplacecategory.h.

Constructor & Destructor Documentation

◆ QPlaceCategory() [1/3]

QPlaceCategory::QPlaceCategory ( )

Constructs a category.

Definition at line 41 of file qplacecategory.cpp.

◆ QPlaceCategory() [2/3]

QPlaceCategory::QPlaceCategory ( const QPlaceCategory & other )

defaultnoexcept

Constructs a category which is a copy of other.

◆ QPlaceCategory() [3/3]

QPlaceCategory::QPlaceCategory ( QPlaceCategory && other )

defaultnoexcept

◆ ~QPlaceCategory()

QPlaceCategory::~QPlaceCategory ( )

default

Destroys the category.

Member Function Documentation

◆ categoryId()

QString QPlaceCategory::categoryId ( ) const

Returns the identifier of the category.

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

Definition at line 95 of file qplacecategory.cpp.

◆ icon()

QPlaceIcon QPlaceCategory::icon ( ) const

Returns the icon associated with the category.

Definition at line 143 of file qplacecategory.cpp.

◆ isEmpty()

bool QPlaceCategory::isEmpty ( ) const

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

Definition at line 159 of file qplacecategory.cpp.

◆ name()

QString QPlaceCategory::name ( ) const

Returns the name of category.

Definition at line 111 of file qplacecategory.cpp.

◆ operator=()

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

noexcept

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

Definition at line 59 of file qplacecategory.cpp.

◆ setCategoryId()

void QPlaceCategory::setCategoryId ( const QString & identifier )

Sets the identifier of the category.

Definition at line 103 of file qplacecategory.cpp.

◆ setIcon()

void QPlaceCategory::setIcon ( const QPlaceIcon & icon )

Sets the icon of the category.

Definition at line 151 of file qplacecategory.cpp.

◆ setName()

void QPlaceCategory::setName ( const QString & name )

Sets the name of the category.

Definition at line 119 of file qplacecategory.cpp.

◆ setVisibility()

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

Sets the visibility of the category.

Definition at line 127 of file qplacecategory.cpp.

◆ swap()

void QPlaceCategory::swap ( QPlaceCategory & other )

inlinenoexcept

Definition at line 32 of file qplacecategory.h.

◆ visibility()

QLocation::Visibility QPlaceCategory::visibility ( ) const

Returns the visibility of the category.

Definition at line 135 of file qplacecategory.cpp.

Friends And Related Symbol Documentation

◆ operator!=

bool operator!=	(	const QPlaceCategory &	lhs,
		const QPlaceCategory &	rhs )

friend

Returns true if lhs is not equal to rhs; otherwise returns false.

Definition at line 36 of file qplacecategory.h.

◆ operator==

bool operator==	(	const QPlaceCategory &	lhs,
		const QPlaceCategory &	rhs )