#include <qdeclarativecategory_p.h>

Inheritance diagram for QDeclarativeCategory:

Collaboration diagram for QDeclarativeCategory:

Public Types
enum	Visibility { UnspecifiedVisibility = QLocation::UnspecifiedVisibility , DeviceVisibility = QLocation::DeviceVisibility , PrivateVisibility = QLocation::PrivateVisibility , PublicVisibility = QLocation::PublicVisibility }

enum	Status { Ready , Saving , Removing , Error }

Signals
void	pluginChanged ()

void	categoryIdChanged ()

void	nameChanged ()

void	visibilityChanged ()

void	iconChanged ()

void	statusChanged ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QDeclarativeCategory (QObject *parent=nullptr)
	\qmltype Category \instantiates QDeclarativeCategory \inqmlmodule QtLocation

	QDeclarativeCategory (const QPlaceCategory &category, QDeclarativeGeoServiceProvider plugin, QObject parent=nullptr)

	~QDeclarativeCategory ()

void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

void	setPlugin (QDeclarativeGeoServiceProvider *plugin)
	\qmlproperty Plugin Category::plugin

QDeclarativeGeoServiceProvider *	plugin () const

QPlaceCategory	category ()

void	setCategory (const QPlaceCategory &category)

QString	categoryId () const

void	setCategoryId (const QString &catID)
	\qmlproperty string Category::categoryId

QString	name () const

void	setName (const QString &name)
	\qmlproperty string Category::name

Visibility	visibility () const
	\qmlproperty enumeration Category::visibility

void	setVisibility (Visibility visibility)

QPlaceIcon	icon () const
	\qmlproperty PlaceIcon Category::icon

void	setIcon (const QPlaceIcon &icon)

Q_INVOKABLE QString	errorString () const
	\qmlmethod string Category::errorString()

Status	status () const
	\qmlproperty enumeration Category::status

void	setStatus (Status status, const QString &errorString=QString())

Q_INVOKABLE void	save (const QString &parentId=QString())
	\qmlmethod void Category::save()

Q_INVOKABLE void	remove ()
	\qmlmethod void Category::remove()

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Properties
QPlaceCategory	category

QDeclarativeGeoServiceProvider *	plugin

QString	categoryId

QString	name

Visibility	visibility

QPlaceIcon	icon

Status	status

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 33 of file qdeclarativecategory_p.h.

Member Enumeration Documentation

◆ Status

enum QDeclarativeCategory::Status

Enumerator
Ready
Saving
Removing
Error

Definition at line 63 of file qdeclarativecategory_p.h.

◆ Visibility

enum QDeclarativeCategory::Visibility

Enumerator
UnspecifiedVisibility
DeviceVisibility
PrivateVisibility
PublicVisibility

Definition at line 57 of file qdeclarativecategory_p.h.

Constructor & Destructor Documentation

◆ QDeclarativeCategory() [1/2]

QT_BEGIN_NAMESPACE QDeclarativeCategory::QDeclarativeCategory ( QObject * parent = nullptr )

explicit

\qmltype Category \instantiates QDeclarativeCategory \inqmlmodule QtLocation

Since: QtLocation 5.5

The Category type represents a category that a \l Place can be associated with.

Categories are used to search for places based on the categories they are associated with. The list of available categories can be obtained from the \l CategoryModel. The \l PlaceSearchModel has a \l {PlaceSearchModel::categories}{categories} property that is used to limit the search results to places with the specified categories.

If the \l Plugin supports it, categories can be created or removed. To create a new category construct a new Category object and set its properties, then invoke the \l save() method.

\codeline

\dots 0

To remove a category ensure that the \l plugin and categoryId properties are set and call the \l remove() method.

See also: CategoryModel

Definition at line 48 of file qdeclarativecategory.cpp.

◆ QDeclarativeCategory() [2/2]

QDeclarativeCategory::QDeclarativeCategory	(	const QPlaceCategory &	category,
		QDeclarativeGeoServiceProvider *	plugin,
		QObject *	parent = nullptr )

Definition at line 53 of file qdeclarativecategory.cpp.

References category, and setCategory().

Here is the call graph for this function:

◆ ~QDeclarativeCategory()

QDeclarativeCategory::~QDeclarativeCategory ( )

Definition at line 61 of file qdeclarativecategory.cpp.

Member Function Documentation

◆ category()

QPlaceCategory QDeclarativeCategory::category ( )

◆ categoryId()

QString QDeclarativeCategory::categoryId ( ) const

Definition at line 151 of file qdeclarativecategory.cpp.

References QPlaceCategory::categoryId().

Here is the call graph for this function:

◆ categoryIdChanged

void QDeclarativeCategory::categoryIdChanged ( )

signal

Referenced by setCategory(), and setCategoryId().

Here is the caller graph for this function:

◆ classBegin()

void QDeclarativeCategory::classBegin ( )

inlineoverridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 66 of file qdeclarativecategory_p.h.

◆ componentComplete()

void QDeclarativeCategory::componentComplete ( )

overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 64 of file qdeclarativecategory.cpp.

◆ errorString()

QString QDeclarativeCategory::errorString ( ) const

\qmlmethod string Category::errorString()

Returns a string description of the error of the last operation. If the last operation completed successfully then the string is empty.

Definition at line 242 of file qdeclarativecategory.cpp.

Referenced by setStatus().

Here is the caller graph for this function:

◆ icon()

QPlaceIcon QDeclarativeCategory::icon ( ) const

\qmlproperty PlaceIcon Category::icon

This property holds the image source associated with the category. To display the icon you can use the \l Image type.

Definition at line 223 of file qdeclarativecategory.cpp.

References QPlaceCategory::icon().

Here is the call graph for this function:

◆ iconChanged

void QDeclarativeCategory::iconChanged ( )

signal

Referenced by setCategory(), and setIcon().

Here is the caller graph for this function:

◆ name()

QString QDeclarativeCategory::name ( ) const

Definition at line 169 of file qdeclarativecategory.cpp.

References QPlaceCategory::name().

Here is the call graph for this function:

◆ nameChanged

void QDeclarativeCategory::nameChanged ( )

signal

Referenced by setCategory(), and setName().

Here is the caller graph for this function:

◆ plugin()

QDeclarativeGeoServiceProvider * QDeclarativeCategory::plugin ( ) const

Definition at line 94 of file qdeclarativecategory.cpp.

◆ pluginChanged

void QDeclarativeCategory::pluginChanged ( )

signal

Referenced by setPlugin().

Here is the caller graph for this function:

◆ remove()

void QDeclarativeCategory::remove ( )

\qmlmethod void Category::remove()

This method permanently removes the category from the backend service.

Definition at line 308 of file qdeclarativecategory.cpp.

References QPlaceCategory::categoryId(), QObject::connect(), QPlaceReply::finished(), QPlaceManager::removeCategory(), Removing, and setStatus().

Here is the call graph for this function:

◆ save()

void QDeclarativeCategory::save ( const QString & parentId = QString() )

\qmlmethod void Category::save()

This method saves the category to the backend service.

Definition at line 291 of file qdeclarativecategory.cpp.

References category, QObject::connect(), QPlaceReply::finished(), QPlaceManager::saveCategory(), Saving, and setStatus().

Here is the call graph for this function:

◆ setCategory()

void QDeclarativeCategory::setCategory ( const QPlaceCategory & category )

Definition at line 117 of file qdeclarativecategory.cpp.

References category, QPlaceCategory::categoryId(), categoryIdChanged(), emit, QPlaceCategory::icon(), iconChanged(), QPlaceCategory::name(), and nameChanged().

Referenced by QDeclarativeCategory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCategoryId()

void QDeclarativeCategory::setCategoryId ( const QString & id )

\qmlproperty string Category::categoryId

This property holds the identifier of the category. The categoryId is a string which uniquely identifies this category within the categories \l plugin.

Definition at line 143 of file qdeclarativecategory.cpp.

References QPlaceCategory::categoryId(), categoryIdChanged(), emit, and QPlaceCategory::setCategoryId().

Here is the call graph for this function:

◆ setIcon()

void QDeclarativeCategory::setIcon ( const QPlaceIcon & icon )

Definition at line 228 of file qdeclarativecategory.cpp.

References emit, icon, QPlaceCategory::icon(), iconChanged(), and QPlaceCategory::setIcon().

Here is the call graph for this function:

◆ setName()

void QDeclarativeCategory::setName ( const QString & name )

\qmlproperty string Category::name

This property holds string based name of the category.

Definition at line 161 of file qdeclarativecategory.cpp.

References emit, QPlaceCategory::name(), nameChanged(), and QPlaceCategory::setName().

Here is the call graph for this function:

◆ setPlugin()

void QDeclarativeCategory::setPlugin ( QDeclarativeGeoServiceProvider * plugin )

\qmlproperty Plugin Category::plugin

This property holds the location based service to which the category belongs.

Definition at line 74 of file qdeclarativecategory.cpp.

References QDeclarativeGeoServiceProvider::attached(), QObject::connect(), emit, QDeclarativeGeoServiceProvider::isAttached, plugin, and pluginChanged().

Here is the call graph for this function:

◆ setStatus()

void QDeclarativeCategory::setStatus	(	Status	status,
		const QString &	errorString = QString() )

Definition at line 247 of file qdeclarativecategory.cpp.

References emit, errorString(), status, and statusChanged().

Referenced by remove(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVisibility()

void QDeclarativeCategory::setVisibility ( Visibility visibility )

Definition at line 208 of file qdeclarativecategory.cpp.

References emit, QPlaceCategory::setVisibility(), visibility, QPlaceCategory::visibility(), and visibilityChanged().

Here is the call graph for this function:

◆ status()

QDeclarativeCategory::Status QDeclarativeCategory::status ( ) const

\qmlproperty enumeration Category::status

This property holds the status of the category. It can be one of:

\table \row

Category.Ready
No error occurred during the last operation, further operations may be performed on the category. \row
Category.Saving
The category is currently being saved, no other operations may be performed until the current operation completes. \row
Category.Removing
The category is currently being removed, no other operations can be performed until the current operation completes. \row
Category.Error
An error occurred during the last operation, further operations can still be performed on the category. \endtable

Definition at line 281 of file qdeclarativecategory.cpp.

◆ statusChanged

void QDeclarativeCategory::statusChanged ( )

signal

Referenced by setStatus().

Here is the caller graph for this function:

◆ visibility()

QDeclarativeCategory::Visibility QDeclarativeCategory::visibility ( ) const

\qmlproperty enumeration Category::visibility

This property holds the visibility of the category. It can be one of:

\table \row

Category.UnspecifiedVisibility
The visibility of the category is unspecified. If saving a category, the plugin will automatically set a default visibility to the category saved in the backend. This default is dependent on the plugin implementation. \row
Category.DeviceVisibility
The category is limited to the current device. The category will not be transferred off of the device. \row
Category.PrivateVisibility
The category is private to the current user. The category may be transferred to an online service but is only ever visible to the current user. \row
Category.PublicVisibility
The category is public. \endtable

Note that visibility does not affect how \l{Place}s associated with the category are displayed in the user-interface of an application on the device. Instead, it defines the sharing semantics of the category.

Definition at line 203 of file qdeclarativecategory.cpp.

References QPlaceCategory::visibility().

Here is the call graph for this function:

◆ visibilityChanged

void QDeclarativeCategory::visibilityChanged ( )

signal

Referenced by setVisibility().

Here is the caller graph for this function:

Property Documentation

◆ category

QPlaceCategory QDeclarativeCategory::category

readwrite

Definition at line 42 of file qdeclarativecategory_p.h.

Referenced by QDeclarativeCategory(), QDeclarativeSearchResultModel::categories_append(), save(), and setCategory().

◆ categoryId

QString QDeclarativeCategory::categoryId

readwrite

Definition at line 44 of file qdeclarativecategory_p.h.

◆ icon

QPlaceIcon QDeclarativeCategory::icon

readwrite

Definition at line 47 of file qdeclarativecategory_p.h.

Referenced by setIcon().

◆ name

QString QDeclarativeCategory::name

readwrite

Definition at line 45 of file qdeclarativecategory_p.h.

◆ plugin

QDeclarativeGeoServiceProvider * QDeclarativeCategory::plugin

readwrite

Definition at line 43 of file qdeclarativecategory_p.h.

Referenced by setPlugin().

◆ status

Status QDeclarativeCategory::status

read

Definition at line 48 of file qdeclarativecategory_p.h.

Referenced by setStatus().

◆ visibility

Visibility QDeclarativeCategory::visibility

readwrite

Definition at line 46 of file qdeclarativecategory_p.h.

Referenced by setVisibility().

The documentation for this class was generated from the following files:

qtlocation/src/location/declarativeplaces/qdeclarativecategory_p.h (60828037eb143eaefab1780f1f831a3f0e6dcaf2)
qtlocation/src/location/declarativeplaces/qdeclarativecategory.cpp (cd4db512ae08836f5fa1d746000052215cf70a9c)

Public Types

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Status

◆ Visibility

Constructor & Destructor Documentation

◆ QDeclarativeCategory() [1/2]

◆ QDeclarativeCategory() [2/2]

◆ ~QDeclarativeCategory()

Member Function Documentation

◆ category()

◆ categoryId()

◆ categoryIdChanged

◆ classBegin()

◆ componentComplete()

◆ errorString()

◆ icon()

◆ iconChanged

◆ name()

◆ nameChanged

◆ plugin()

◆ pluginChanged

◆ remove()

◆ save()

◆ setCategory()

◆ setCategoryId()

◆ setIcon()

◆ setName()

◆ setPlugin()

◆ setStatus()

◆ setVisibility()

◆ status()

◆ statusChanged

◆ visibility()

◆ visibilityChanged

Property Documentation

◆ category

◆ categoryId

◆ icon

◆ name

◆ plugin

◆ status

◆ visibility