Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QPlaceReply Class Reference

\inmodule QtLocation More...

#include <qplacereply.h>

+ Inheritance diagram for QPlaceReply:
+ Collaboration diagram for QPlaceReply:

Public Types

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 Slots

virtual void abort ()
 Cancels the operation immediately.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

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.
 

Public Member Functions

 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.
 
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.
 

Protected Member Functions

 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)
 

Protected Attributes

QPlaceReplyPrivate * d_ptr
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 

Additional Inherited Members

- 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)
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

\inmodule QtLocation

Since
5.6

The QPlaceReply class manages an operation started by an instance of QPlaceManager and serves as a base class for more specialized replies.

The QPlaceReply and each of its specialized subclasses manage the state and results of their corresponding operations. The QPlaceReply itself is used for operations that have no results, that is, it only necessary to know if the operation succeeded or failed.

The finished() signal can be used to monitor the progress of an operation. Once an operation is complete, the error() and errorString() methods provide information on whether the operation completed successfully. If successful, the reply will contain the results for that operation, that is, each subclass will have appropriate functions to retrieve the results of an operation.

See also
QPlaceManager

Definition at line 14 of file qplacereply.h.

Member Enumeration Documentation

◆ Error

enum QPlaceReply::Error

Describes an error which occurred during an operation.

\value NoError No error has occurred \value PlaceDoesNotExistError A specified place could not be found \value CategoryDoesNotExistError A specified category could not be found \value CommunicationError An error occurred communicating with the service provider. \value ParseError The response from the service provider or an import file was in an unrecognizable format \value PermissionsError The operation failed because of insufficient permissions. \value UnsupportedError The operation was not supported by the service provider. \value BadArgumentError. A parameter that was provided was invalid. \value CancelError The operation was canceled. \value UnknownError An error occurred which does not fit into any of the other categories.

Enumerator
NoError 
PlaceDoesNotExistError 
CategoryDoesNotExistError 
CommunicationError 
ParseError 
PermissionsError 
UnsupportedError 
BadArgumentError 
CancelError 
UnknownError 

Definition at line 18 of file qplacereply.h.

◆ Type

enum QPlaceReply::Type

Describes the reply's type.

\value Reply This is a generic reply. \value DetailsReply This is a reply for the retrieval of place details \value SearchReply This is a reply for the place search operation. \value SearchSuggestionReply This is a reply for a search suggestion operation. \value ContentReply This is a reply for content associated with a place. \value IdReply This is a reply that returns an identifier of a place or category. Typically used for place or category save and remove operations. \value MatchReply This is a reply that returns places that match those from another provider.

Enumerator
Reply 
DetailsReply 
SearchReply 
SearchSuggestionReply 
ContentReply 
IdReply 
MatchReply 

Definition at line 31 of file qplacereply.h.

Constructor & Destructor Documentation

◆ QPlaceReply() [1/2]

QPlaceReply::QPlaceReply ( QObject * parent = nullptr)
explicit

Constructs a reply object with a given parent.

Definition at line 84 of file qplacereply.cpp.

◆ ~QPlaceReply()

QPlaceReply::~QPlaceReply ( )

Destroys the reply object.

Definition at line 100 of file qplacereply.cpp.

References abort(), d_ptr, and isFinished().

+ Here is the call graph for this function:

◆ QPlaceReply() [2/2]

QPlaceReply::QPlaceReply ( QPlaceReplyPrivate * dd,
QObject * parent = nullptr )
explicitprotected

Definition at line 92 of file qplacereply.cpp.

Member Function Documentation

◆ abort

void QPlaceReply::abort ( )
virtualslot

Cancels the operation immediately.

See also
aborted()

Definition at line 179 of file qplacereply.cpp.

References aborted(), and emit.

Referenced by ~QPlaceReply(), QDeclarativeSearchModelBase::cancel(), QDeclarativePlaceContentModel::clearData(), and RequestHandler::saveBetweenManagers().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ aborted

void QPlaceReply::aborted ( )
signal
Since
5.9

This signal is emitted when the operation has been cancelled.

See also
abort()

Referenced by PlaceSearchReplyEsri::PlaceSearchReplyEsri(), QPlaceContentReplyImpl::QPlaceContentReplyImpl(), QPlaceDetailsReplyImpl::QPlaceDetailsReplyImpl(), QPlaceSearchReplyHere::QPlaceSearchReplyHere(), QPlaceSearchReplyMapbox::QPlaceSearchReplyMapbox(), QPlaceSearchReplyOsm::QPlaceSearchReplyOsm(), QPlaceSearchSuggestionReplyImpl::QPlaceSearchSuggestionReplyImpl(), QPlaceSearchSuggestionReplyMapbox::QPlaceSearchSuggestionReplyMapbox(), and abort().

+ Here is the caller graph for this function:

◆ contentUpdated

void QPlaceReply::contentUpdated ( )
signal

This signal is emitted when this reply has updated content available.

Depending on the plugin, this signal may never be emitted or emitted multiple times before \l QPlaceReply::finished() is emitted, as some backends are able to return the requested content asynchronously and incrementally.

Note
Do not delete or deleteLater this reply object in the slot connected to this signal. Do it only upon \l QPlaceReply::finished.

Referenced by QDeclarativeSearchResultModel::queryFinished(), and QDeclarativeSearchModelBase::update().

+ Here is the caller graph for this function:

◆ error()

QPlaceReply::Error QPlaceReply::error ( ) const

Returns the error code.

Definition at line 160 of file qplacereply.cpp.

References d_ptr, and QPlaceReplyPrivate::error.

Referenced by RequestHandler::contentHandler(), RequestHandler::handleDetailsReply(), RequestHandler::handleImagesReply(), RequestHandler::handleInitCatReply(), RequestHandler::handleRemoveCategoryReply(), RequestHandler::handleRemovePlaceReply(), RequestHandler::handleSaveCategoryReply(), RequestHandler::handleSavePlaceReply(), RequestHandler::handleSearchReply(), RequestHandler::handleSuggestionReply(), RequestHandler::matchHandler(), RequestHandler::processSearchReply(), QDeclarativeSearchSuggestionModel::queryFinished(), setError(), and SearchSuggestionReply::triggerDone().

+ Here is the caller graph for this function:

◆ errorOccurred

void QPlaceReply::errorOccurred ( QPlaceReply::Error error,
const QString & errorString = QString() )
signal

This signal is emitted when an error has been detected in the processing of this reply.

The finished() signal will probably follow.

The error will be described by the error code error. If errorString is not empty it will contain a textual description of the error meant for developers and not end users.

This signal and QPlaceManager::errorOccurred() will be emitted at the same time.

Note
Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.

Referenced by QPlaceManagerEngineNokiaV2::getPlaceContent(), QPlaceManagerEngineNokiaV2::getPlaceDetails(), PlaceManagerEngineEsri::initializeCategories(), QPlaceManagerEngineMapbox::initializeCategories(), QPlaceManagerEngineNokiaV2::initializeCategories(), QPlaceManagerEngineOsm::initializeCategories(), QPlaceManagerEngineNokiaV2::search(), PlaceManagerEngineEsri::search(), QPlaceManagerEngineOsm::search(), QPlaceManagerEngineNokiaV2::searchSuggestions(), PlaceCategoriesReplyEsri::setError(), QPlaceCategoriesReplyMapbox::setError(), QPlaceSearchReplyMapbox::setError(), QPlaceSearchSuggestionReplyMapbox::setError(), and QPlaceCategoriesReplyOsm::setError().

+ Here is the caller graph for this function:

◆ errorString()

QString QPlaceReply::errorString ( ) const

Returns the error string of the reply.

The error string is intended to be used by developers only and is not fit to be displayed to an end user.

If no error has occurred, the string is empty.

Definition at line 152 of file qplacereply.cpp.

References d_ptr, and QPlaceReplyPrivate::errorString.

Referenced by QDeclarativeSearchSuggestionModel::queryFinished(), setError(), PlaceCategoriesReplyEsri::setError(), QPlaceCategoriesReplyMapbox::setError(), QPlaceSearchReplyMapbox::setError(), QPlaceSearchSuggestionReplyMapbox::setError(), QPlaceCategoriesReplyOsm::setError(), and SearchSuggestionReply::triggerDone().

+ Here is the caller graph for this function:

◆ finished

void QPlaceReply::finished ( )
signal

This signal is emitted when this reply has finished processing.

If error() equals QPlaceReply::NoError then the processing finished successfully.

This signal and QPlaceManager::finished() will be emitted at the same time.

Note
Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.

Referenced by RequestHandler::details(), PlaceCategoriesReplyEsri::emitFinished(), QPlaceCategoriesReplyHere::emitFinished(), QPlaceCategoriesReplyOsm::emitFinished(), QDeclarativePlaceContentModel::fetchMore(), QPlaceCategoriesReplyMapbox::finish(), QDeclarativePlace::getDetails(), QPlaceManagerEngineNokiaV2::getPlaceContent(), QPlaceManagerEngineNokiaV2::getPlaceDetails(), RequestHandler::images(), RequestHandler::initializeCategories(), PlaceManagerEngineEsri::initializeCategories(), QPlaceManagerEngineMapbox::initializeCategories(), QPlaceManagerEngineNokiaV2::initializeCategories(), QPlaceManagerEngineOsm::initializeCategories(), QDeclarativeSearchModelBase::initializePlugin(), QDeclarativeSearchResultModel::queryFinished(), QDeclarativeCategory::remove(), QDeclarativePlace::remove(), RequestHandler::removeCategory(), RequestHandler::removePlace(), QDeclarativePlace::save(), QDeclarativeCategory::save(), RequestHandler::saveCategory(), RequestHandler::savePlace(), RequestHandler::search(), QPlaceManagerEngineNokiaV2::search(), PlaceManagerEngineEsri::search(), QPlaceManagerEngineOsm::search(), QPlaceManagerEngineNokiaV2::searchSuggestions(), QPlaceSearchReplyMapbox::setError(), QPlaceSearchSuggestionReplyMapbox::setError(), QDeclarativeSearchResultModel::setFavoritesPlugin(), setFinished(), RequestHandler::simpleSearch(), QDeclarativeSearchModelBase::update(), and QDeclarativeSupportedCategoriesModel::update().

+ Here is the caller graph for this function:

◆ isFinished()

bool QPlaceReply::isFinished ( ) const

Return true if the reply has completed.

Definition at line 111 of file qplacereply.cpp.

References d_ptr, and QPlaceReplyPrivate::isFinished.

Referenced by ~QPlaceReply(), and QDeclarativeSearchModelBase::cancel().

+ Here is the caller graph for this function:

◆ setError()

void QPlaceReply::setError ( QPlaceReply::Error error,
const QString & errorString )
protected

Sets the error and errorString of the reply.

This function does not cause the QPlaceReply::errorOccurred(QPlaceReply::Error, const QString &errorString) signal to be emitted.

Definition at line 140 of file qplacereply.cpp.

References d_ptr, error(), QPlaceReplyPrivate::error, errorString(), and QPlaceReplyPrivate::errorString.

Referenced by PlaceCategoriesReplyEsri::setError(), QPlaceCategoriesReplyMapbox::setError(), QPlaceSearchReplyMapbox::setError(), QPlaceSearchSuggestionReplyMapbox::setError(), QPlaceCategoriesReplyOsm::setError(), and SearchSuggestionReply::triggerDone().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setFinished()

void QPlaceReply::setFinished ( bool finished)
protected

Sets the status of whether the reply is finished or not.

This function does not cause the finished() signal to be emitted.

Definition at line 129 of file qplacereply.cpp.

References d_ptr, finished(), and QPlaceReplyPrivate::isFinished.

Referenced by PlaceCategoriesReplyEsri::emitFinished(), QPlaceCategoriesReplyHere::emitFinished(), QPlaceCategoriesReplyOsm::emitFinished(), QPlaceCategoriesReplyMapbox::finish(), QPlaceSearchReplyMapbox::setError(), QPlaceSearchSuggestionReplyMapbox::setError(), and SearchSuggestionReply::triggerDone().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ type()

QPlaceReply::Type QPlaceReply::type ( ) const
virtual

Returns the type of the reply.

Reimplemented in QPlaceContentReply, QPlaceDetailsReply, QPlaceIdReply, QPlaceMatchReply, QPlaceSearchReply, and QPlaceSearchSuggestionReply.

Definition at line 119 of file qplacereply.cpp.

References Reply.

Member Data Documentation

◆ d_ptr

QPlaceReplyPrivate* QPlaceReply::d_ptr
protected

Definition at line 64 of file qplacereply.h.

Referenced by ~QPlaceReply(), error(), errorString(), isFinished(), setError(), and setFinished().

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