QPlaceIdReply Class Reference

\inmodule QtLocation More...

#include <qplaceidreply.h>

Inheritance diagram for QPlaceIdReply:

Collaboration diagram for QPlaceIdReply:

Public Types
enum	OperationType { SavePlace , SaveCategory , RemovePlace , RemoveCategory }
	Defines the type of operation that was used to generate this reply. More...
Public Types inherited from QPlaceReply
enum	Error {   NoError , PlaceDoesNotExistError , CategoryDoesNotExistError , CommunicationError ,   ParseError , PermissionsError , UnsupportedError , BadArgumentError ,   CancelError , UnknownError }
	Describes an error which occurred during an operation. More...
enum	Type {   Reply , DetailsReply , SearchReply , SearchSuggestionReply ,   ContentReply , IdReply , MatchReply }
	Describes the reply's type. More...

Public Member Functions
	QPlaceIdReply (OperationType operationType, QObject *parent=nullptr)
	Constructs a reply which contains the identifier of the object operated upon.
virtual	~QPlaceIdReply ()
	Destroys the reply.
QPlaceReply::Type	type () const override
	Returns the type of reply.
OperationType	operationType () const
	Returns the operation type of the reply.
QString	id () const
	Returns the relevant identifier for the operation.
Public Member Functions inherited from QPlaceReply
	QPlaceReply (QObject *parent=nullptr)
	Constructs a reply object with a given parent.
	~QPlaceReply ()
	Destroys the reply object.
bool	isFinished () const
	Return true if the reply has completed.
virtual Type	type () const
	Returns the type of the reply.
QString	errorString () const
	Returns the error string of the reply.
QPlaceReply::Error	error () const
	Returns the error code.
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.
void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.
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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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.

Protected Member Functions
void	setId (const QString &identifier)
	Sets the identifier of the reply.
Protected Member Functions inherited from QPlaceReply
	QPlaceReply (QPlaceReplyPrivate *, QObject *parent=nullptr)
void	setFinished (bool finished)
	Sets the status of whether the reply is finished or not.
void	setError (QPlaceReply::Error error, const QString &errorString)
	Sets the error and errorString of the reply.
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)

Additional Inherited Members
Public Slots inherited from QPlaceReply
virtual void	abort ()
	Cancels the operation immediately.
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from QPlaceReply
void	finished ()
	This signal is emitted when this reply has finished processing.
void	contentUpdated ()
	This signal is emitted when this reply has updated content available.
void	aborted ()
void	errorOccurred (QPlaceReply::Error error, const QString &errorString=QString())
	This signal is emitted when an error has been detected in the processing of this reply.
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.
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 Attributes inherited from QPlaceReply
QPlaceReplyPrivate *	d_ptr
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
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

\inmodule QtLocation

Since

5.6

The QPlaceIdReply class manages operations which return an identifier such as saving and removal operations of places and categories.

The QPlaceIdReply can be considered a multipurpose reply in that it can be used to save places, save categories, remove places and remove categories. In each case it returns an identifier of the place or category that was added, modified or removed.

See \l {Saving a place cpp}{Saving a place} for an example of how to use an identifier reply.

See also

QPlaceManager

Definition at line 12 of file qplaceidreply.h.

Member Enumeration Documentation

OperationType

enum QPlaceIdReply::OperationType

Defines the type of operation that was used to generate this reply.

\value SavePlace The reply was created for a save place operation \value RemovePlace The reply was created for a remove place operation. \value SaveCategory The reply was created for a save category operation \value RemoveCategory The reply was created for a remove category operation.

Enumerator
SavePlace
SaveCategory
RemovePlace
RemoveCategory

Definition at line 16 of file qplaceidreply.h.

Constructor & Destructor Documentation

QPlaceIdReply()

QPlaceIdReply::QPlaceIdReply ( QPlaceIdReply::OperationType  operationType, QObject *  parent = nullptr  )

explicit

Constructs a reply which contains the identifier of the object operated upon.

The reply is for the given operationType and with parent.

Definition at line 52 of file qplaceidreply.cpp.

~QPlaceIdReply()

QPlaceIdReply::~QPlaceIdReply ( )

virtual

Destroys the reply.

Definition at line 58 of file qplaceidreply.cpp.

Member Function Documentation

id()

QString QPlaceIdReply::id

(

)

const

Returns the relevant identifier for the operation.

For example for a save place operation, the identifier is that of the saved place. For a category removal operation, it is the identifier of the category that was removed.

Definition at line 86 of file qplaceidreply.cpp.

References d.

Referenced by RequestHandler::handleRemoveCategoryReply(), RequestHandler::handleRemovePlaceReply(), RequestHandler::handleSaveCategoryReply(), and RequestHandler::handleSavePlaceReply().

Here is the caller graph for this function:

operationType()

QPlaceIdReply::OperationType QPlaceIdReply::operationType

(

)

const

Returns the operation type of the reply.

This means whether this identifier reply was for a save place operation, remove category operation and so on.

Definition at line 75 of file qplaceidreply.cpp.

References d.

setId()

void QPlaceIdReply::setId ( const QString &  identifier )

protected

Sets the identifier of the reply.

Definition at line 95 of file qplaceidreply.cpp.

References d.

type()

QPlaceReply::Type QPlaceIdReply::type ( ) const

overridevirtual

Returns the type of reply.

Reimplemented from QPlaceReply.

Definition at line 65 of file qplaceidreply.cpp.

References QPlaceReply::IdReply.

---

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

• qtlocation/src/location/places/qplaceidreply.h
• qtlocation/src/location/places/qplaceidreply.cpp