diff options
author | Alex Blasche <alexander.blasche@digia.com> | 2013-08-29 11:27:50 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-09-03 09:06:50 +0200 |
commit | fc53ebdbd043642aaab0ce39f48d7c05231d10fd (patch) | |
tree | edb5635f9fb1c9252f31434452e05e75d7b9bcb7 /src/location/maps/qgeocodingmanagerengine.cpp | |
parent | 9f98392aff316bff0b89ac20234234e1e3f060e2 (diff) |
Fix some name inconsistencies in QtLocation
1. Rename QGeocoding* classes to QGeoCoding*. This emphasizes the QGeo
prefix rather than the geocing word. The QML interfaces continues to use
the Geocoding* as they don't a prefix as such.
2. Rename QProposedSearchResult to QPlaceProposedSearchResult. The class is place
related and should carry the QPlace name prefix
Change-Id: I428c7e6368774a9f199db5c113de11649e4a665c
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Reviewed-by: Aaron McCarthy <mccarthy.aaron@gmail.com>
Diffstat (limited to 'src/location/maps/qgeocodingmanagerengine.cpp')
-rw-r--r-- | src/location/maps/qgeocodingmanagerengine.cpp | 110 |
1 files changed, 55 insertions, 55 deletions
diff --git a/src/location/maps/qgeocodingmanagerengine.cpp b/src/location/maps/qgeocodingmanagerengine.cpp index 3ba59f68..f3aa2870 100644 --- a/src/location/maps/qgeocodingmanagerengine.cpp +++ b/src/location/maps/qgeocodingmanagerengine.cpp @@ -50,18 +50,18 @@ QT_BEGIN_NAMESPACE /*! - \class QGeocodingManagerEngine + \class QGeoCodingManagerEngine \inmodule QtLocation \ingroup QtLocation-impl \since Qt Location 5.0 - \brief The QGeocodingManagerEngine class provides an interface and + \brief The QGeoCodingManagerEngine class provides an interface and convenience methods to implementers of QGeoServiceProvider plugins who want to provide support for geocoding operations. In the default implementation, supportsGeocoding() and supportsReverseGeocoding() returns false while geocode() and reverseGeocode() - cause QGeocodeReply::UnsupportedOptionError to occur. + cause QGeoCodeReply::UnsupportedOptionError to occur. If the service provider supports geocoding the subclass should provide an implementation of geocode() and call setSupportsGeocoding(true) at @@ -72,21 +72,21 @@ QT_BEGIN_NAMESPACE setSupportsReverseGeocoding(true) at some point in time before reverseGeocode() is called. - A subclass of QGeocodingManagerEngine will often make use of a subclass - fo QGeocodeReply internally, in order to add any engine-specific + A subclass of QGeoCodingManagerEngine will often make use of a subclass + fo QGeoCodeReply internally, in order to add any engine-specific data (such as a QNetworkReply object for network-based services) to the - QGeocodeReply instances used by the engine. + QGeoCodeReply instances used by the engine. - \sa QGeocodingManager + \sa QGeoCodingManager */ /*! Constructs a new engine with the specified \a parent, using \a parameters to pass any implementation specific data to the engine. */ -QGeocodingManagerEngine::QGeocodingManagerEngine(const QMap<QString, QVariant> ¶meters, QObject *parent) +QGeoCodingManagerEngine::QGeoCodingManagerEngine(const QMap<QString, QVariant> ¶meters, QObject *parent) : QObject(parent), - d_ptr(new QGeocodingManagerEnginePrivate()) + d_ptr(new QGeoCodingManagerEnginePrivate()) { Q_UNUSED(parameters) } @@ -94,7 +94,7 @@ QGeocodingManagerEngine::QGeocodingManagerEngine(const QMap<QString, QVariant> & /*! Destroys this engine. */ -QGeocodingManagerEngine::~QGeocodingManagerEngine() +QGeoCodingManagerEngine::~QGeoCodingManagerEngine() { delete d_ptr; } @@ -106,7 +106,7 @@ QGeocodingManagerEngine::~QGeocodingManagerEngine() The combination of managerName() and managerVersion() should be unique amongst plugin implementations. */ -void QGeocodingManagerEngine::setManagerName(const QString &managerName) +void QGeoCodingManagerEngine::setManagerName(const QString &managerName) { d_ptr->managerName = managerName; } @@ -118,7 +118,7 @@ void QGeocodingManagerEngine::setManagerName(const QString &managerName) The combination of managerName() and managerVersion() should be unique amongst plugin implementations. */ -QString QGeocodingManagerEngine::managerName() const +QString QGeoCodingManagerEngine::managerName() const { return d_ptr->managerName; } @@ -129,7 +129,7 @@ QString QGeocodingManagerEngine::managerName() const The combination of managerName() and managerVersion() should be unique amongst plugin implementations. */ -void QGeocodingManagerEngine::setManagerVersion(int managerVersion) +void QGeoCodingManagerEngine::setManagerVersion(int managerVersion) { d_ptr->managerVersion = managerVersion; } @@ -140,7 +140,7 @@ void QGeocodingManagerEngine::setManagerVersion(int managerVersion) The combination of managerName() and managerVersion() should be unique amongst plugin implementations. */ -int QGeocodingManagerEngine::managerVersion() const +int QGeoCodingManagerEngine::managerVersion() const { return d_ptr->managerVersion; } @@ -149,16 +149,16 @@ int QGeocodingManagerEngine::managerVersion() const Begins the geocoding of \a address. Geocoding is the process of finding a coordinate that corresponds to a given address. - A QGeocodeReply object will be returned, which can be used to manage the + A QGeoCodeReply object will be returned, which can be used to manage the geocoding operation and to return the results of the operation. - This engine and the returned QGeocodeReply object will emit signals + This engine and the returned QGeoCodeReply object will emit signals indicating if the operation completes or if errors occur. If supportsGeocoding() returns false an - QGeocodeReply::UnsupportedOptionError will occur. + QGeoCodeReply::UnsupportedOptionError will occur. - Once the operation has completed, QGeocodeReply::locations() can be used to + Once the operation has completed, QGeoCodeReply::locations() can be used to retrieve the results, which will consist of a list of QGeoLocation objects. These objects represent a combination of coordinate and address data. @@ -172,16 +172,16 @@ int QGeocodingManagerEngine::managerVersion() const service will attempt to geocode all matches for the specified data. The user is responsible for deleting the returned reply object, although - this can be done in the slot connected to QGeocodingManagerEngine::finished(), - QGeocodingManagerEngine::error(), QGeocodeReply::finished() or - QGeocodeReply::error() with deleteLater(). + this can be done in the slot connected to QGeoCodingManagerEngine::finished(), + QGeoCodingManagerEngine::error(), QGeoCodeReply::finished() or + QGeoCodeReply::error() with deleteLater(). */ -QGeocodeReply *QGeocodingManagerEngine::geocode(const QGeoAddress &address, +QGeoCodeReply *QGeoCodingManagerEngine::geocode(const QGeoAddress &address, const QGeoShape &bounds) { Q_UNUSED(address) Q_UNUSED(bounds) - return new QGeocodeReply(QGeocodeReply::UnsupportedOptionError, + return new QGeoCodeReply(QGeoCodeReply::UnsupportedOptionError, QLatin1String("Geocoding is not supported by this service provider."), this); } @@ -189,16 +189,16 @@ QGeocodeReply *QGeocodingManagerEngine::geocode(const QGeoAddress &address, Begins the reverse geocoding of \a coordinate. Reverse geocoding is the process of finding an address that corresponds to a given coordinate. - A QGeocodeReply object will be returned, which can be used to manage the + A QGeoCodeReply object will be returned, which can be used to manage the reverse geocoding operation and to return the results of the operation. - This engine and the returned QGeocodeReply object will emit signals + This engine and the returned QGeoCodeReply object will emit signals indicating if the operation completes or if errors occur. If supportsReverseGeocoding() returns false an - QGeocodeReply::UnsupportedOptionError will occur. + QGeoCodeReply::UnsupportedOptionError will occur. - At that point QGeocodeReply::locations() can be used to retrieve the + At that point QGeoCodeReply::locations() can be used to retrieve the results, which will consist of a list of QGeoLocation objects. These objects represent a combination of coordinate and address data. @@ -217,29 +217,29 @@ QGeocodeReply *QGeocodingManagerEngine::geocode(const QGeoAddress &address, limit the results to those that are contained by \a bounds. The user is responsible for deleting the returned reply object, although - this can be done in the slot connected to QGeocodingManagerEngine::finished(), - QGeocodingManagerEngine::error(), QGeocodeReply::finished() or - QGeocodeReply::error() with deleteLater(). + this can be done in the slot connected to QGeoCodingManagerEngine::finished(), + QGeoCodingManagerEngine::error(), QGeoCodeReply::finished() or + QGeoCodeReply::error() with deleteLater(). */ -QGeocodeReply *QGeocodingManagerEngine::reverseGeocode(const QGeoCoordinate &coordinate, - const QGeoShape &bounds) +QGeoCodeReply *QGeoCodingManagerEngine::reverseGeocode(const QGeoCoordinate &coordinate, + const QGeoShape &bounds) { Q_UNUSED(coordinate) Q_UNUSED(bounds) - return new QGeocodeReply(QGeocodeReply::UnsupportedOptionError, + return new QGeoCodeReply(QGeoCodeReply::UnsupportedOptionError, QLatin1String("Reverse geocoding is not supported by this service provider."), this); } /*! Begins geocoding for a location matching \a address. - A QGeocodeReply object will be returned, which can be used to manage the + A QGeoCodeReply object will be returned, which can be used to manage the geocoding operation and to return the results of the operation. - This engine and the returned QGeocodeReply object will emit signals + This engine and the returned QGeoCodeReply object will emit signals indicating if the operation completes or if errors occur. - Once the operation has completed, QGeocodeReply::locations() can be used to + Once the operation has completed, QGeoCodeReply::locations() can be used to retrieve the results, which will consist of a list of QGeoLocation objects. These objects represent a combination of coordinate and address data. @@ -255,22 +255,22 @@ QGeocodeReply *QGeocodingManagerEngine::reverseGeocode(const QGeoCoordinate &coo limit the results to those that are contained by \a bounds. The user is responsible for deleting the returned reply object, although - this can be done in the slot connected to QGeocodingManagerEngine::finished(), - QGeocodingManagerEngine::error(), QGeocodeReply::finished() or - QGeocodeReply::error() with deleteLater(). + this can be done in the slot connected to QGeoCodingManagerEngine::finished(), + QGeoCodingManagerEngine::error(), QGeoCodeReply::finished() or + QGeoCodeReply::error() with deleteLater(). */ -QGeocodeReply *QGeocodingManagerEngine::geocode(const QString &address, - int limit, - int offset, - const QGeoShape &bounds) +QGeoCodeReply *QGeoCodingManagerEngine::geocode(const QString &address, + int limit, + int offset, + const QGeoShape &bounds) { Q_UNUSED(address) Q_UNUSED(limit) Q_UNUSED(offset) Q_UNUSED(bounds) - return new QGeocodeReply(QGeocodeReply::UnsupportedOptionError, - QLatin1String("Searching is not supported by this service provider."), this); + return new QGeoCodeReply(QGeoCodeReply::UnsupportedOptionError, + QLatin1String("Searching is not supported by this service provider."), this); } /*! @@ -281,7 +281,7 @@ QGeocodeReply *QGeocodingManagerEngine::geocode(const QString &address, The locale used defaults to the system locale if this is not set. */ -void QGeocodingManagerEngine::setLocale(const QLocale &locale) +void QGeoCodingManagerEngine::setLocale(const QLocale &locale) { d_ptr->locale = locale; } @@ -290,20 +290,20 @@ void QGeocodingManagerEngine::setLocale(const QLocale &locale) Returns the locale used to hint to this geocoding manager about what language to use for the results. */ -QLocale QGeocodingManagerEngine::locale() const +QLocale QGeoCodingManagerEngine::locale() const { return d_ptr->locale; } /*! -\fn void QGeocodingManagerEngine::finished(QGeocodeReply *reply) +\fn void QGeoCodingManagerEngine::finished(QGeoCodeReply *reply) This signal is emitted when \a reply has finished processing. - If reply::error() equals QGeocodeReply::NoError then the processing + If reply::error() equals QGeoCodeReply::NoError then the processing finished successfully. - This signal and QGeocodeReply::finished() will be emitted at the same + This signal and QGeoCodeReply::finished() will be emitted at the same time. \note Do not delete the \a reply object in the slot connected to this @@ -311,15 +311,15 @@ QLocale QGeocodingManagerEngine::locale() const */ /*! -\fn void QGeocodingManagerEngine::error(QGeocodeReply *reply, QGeocodeReply::Error error, QString errorString) +\fn void QGeoCodingManagerEngine::error(QGeoCodeReply *reply, QGeoCodeReply::Error error, QString errorString) This signal is emitted when an error has been detected in the processing of - \a reply. The QGeocodingManagerEngine::finished() signal will probably follow. + \a reply. The QGeoCodingManagerEngine::finished() signal will probably follow. The error will be described by the error code \a error. If \a errorString is not empty it will contain a textual description of the error. - This signal and QGeocodeReply::error() will be emitted at the same time. + This signal and QGeoCodeReply::error() will be emitted at the same time. \note Do not delete the \a reply object in the slot connected to this signal. Use deleteLater() instead. @@ -328,11 +328,11 @@ QLocale QGeocodingManagerEngine::locale() const /******************************************************************************* *******************************************************************************/ -QGeocodingManagerEnginePrivate::QGeocodingManagerEnginePrivate() +QGeoCodingManagerEnginePrivate::QGeoCodingManagerEnginePrivate() : managerVersion(-1) {} -QGeocodingManagerEnginePrivate::~QGeocodingManagerEnginePrivate() +QGeoCodingManagerEnginePrivate::~QGeoCodingManagerEnginePrivate() { } |