QGeoSearchManagerEngine Class Reference

 #include <QGeoSearchManagerEngine>

Member Function Documentation

QGeoSearchManagerEngine::QGeoSearchManagerEngine ( const QMap<QString, QVariant> & parameters, QObject * parent = 0 )

Constructs a new engine with the specified parent, using parameters to pass any implementation specific data to the engine.

QGeoSearchManagerEngine::~QGeoSearchManagerEngine () [virtual]

Destroys this engine.

void QGeoSearchManagerEngine::addAdditionalLandmarkManager ( QLandmarkManager * landmarkManager )

Adds landmarkManager to the list of landmark managers that will be used with search().

These landmark managers will be used along with the landmark manager returned by defaultLandmarkManager().

This function was introduced in Qt Mobility 1.1.

QList<QLandmarkManager *> QGeoSearchManagerEngine::additionalLandmarkManagers () const

Returns the landmark managers that will be used with search().

These landmark managers will be used along with the landmark manager returned by defaultLandmarkManager().

This function was introduced in Qt Mobility 1.1.

See also setAdditionalLandmarkManagers().

QLandmarkManager * QGeoSearchManagerEngine::defaultLandmarkManager () const

Returns the landmark manager provided by the service provider for use with search().

Will return 0 if the no landmark manager is associated with the service provider. This does not indicate that search() does not support landmark searching, only that any landmark searching which occurs within in search() is done without the use of a QLandmarkManager.

This function was introduced in Qt Mobility 1.1.

See also setDefaultLandmarkManager().

void QGeoSearchManagerEngine::error ( QGeoSearchReply * reply, QGeoSearchReply::Error error, QString errorString = QString() ) [signal]

This signal is emitted when an error has been detected in the processing of reply. The QGeoSearchManagerEngine::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.

This signal and QGeoSearchReply::error() will be emitted at the same time.

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

This function was introduced in Qt Mobility 1.1.

void QGeoSearchManagerEngine::finished ( QGeoSearchReply * reply ) [signal]

This signal is emitted when reply has finished processing.

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

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

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

This function was introduced in Qt Mobility 1.1.

QGeoSearchReply * QGeoSearchManagerEngine::geocode ( const QGeoAddress & address, QGeoBoundingArea * bounds ) [virtual]

Begins the geocoding of address. Geocoding is the process of finding a coordinate that corresponds to a given address.

A QGeoSearchReply 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 QGeoSearchReply object will emit signals indicating if the operation completes or if errors occur.

If supportsGeocoding() returns false an QGeoSearchReply::UnsupportedOptionError will occur.

Once the operation has completed, QGeoSearchReply::places() can be used to retrieve the results, which will consist of a list of QGeoPlace objects. These object represent a combination of coordinate and address data.

The address data returned in the results may be different from address. This will usually occur if the geocoding service backend uses a different canonical form of addresses or if address was only partially filled out.

If bounds is non-null and a valid QGeoBoundingArea it will be used to limit the results to those that are contained by bounds. This is particularly useful if address is only partially filled out, as the 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 QGeoSearchManagerEngine::finished(), QGeoSearchManagerEngine::error(), QGeoSearchReply::finished() or QGeoSearchReply::error() with deleteLater().

This function was introduced in Qt Mobility 1.1.

QLocale QGeoSearchManagerEngine::locale () const

Returns the locale used to hint to this search manager about what language to use for the results.

This function was introduced in Qt Mobility 1.1.

See also setLocale().

QString QGeoSearchManagerEngine::managerName () const

Returns the name which this engine implementation uses to distinguish itself from the implementations provided by other plugins.

The combination of managerName() and managerVersion() should be unique amongst plugin implementations.

This function was introduced in Qt Mobility 1.1.

int QGeoSearchManagerEngine::managerVersion () const

Returns the version of this engine implementation.

The combination of managerName() and managerVersion() should be unique amongst plugin implementations.

This function was introduced in Qt Mobility 1.1.

QGeoSearchReply * QGeoSearchManagerEngine::reverseGeocode ( const QGeoCoordinate & coordinate, QGeoBoundingArea * bounds ) [virtual]

Begins the reverse geocoding of coordinate. Reverse geocoding is the process of finding an address that corresponds to a given coordinate.

A QGeoSearchReply 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 QGeoSearchReply object will emit signals indicating if the operation completes or if errors occur.

If supportsReverseGeocoding() returns false an QGeoSearchReply::UnsupportedOptionError will occur.

At that point QGeoSearchReply::places() can be used to retrieve the results, which will consist of a list of QGeoPlace objects. These object represent a combination of coordinate and address data.

The coordinate data returned in the results may be different from coordinate. This will usually occur if the reverse geocoding service backend shifts the coordinates to be closer to the matching addresses, or if the backend returns results at multiple levels of detail.

If multiple results are returned by the reverse geocoding service backend they will be provided in order of specificity. This normally occurs if the backend is configured to reverse geocode across multiple levels of detail. As an example, some services will return address and coordinate pairs for the street address, the city, the state and the country.

If bounds is non-null and a valid QGeoBoundingArea it will be used to limit the results to those that are contained by bounds.

The user is responsible for deleting the returned reply object, although this can be done in the slot connected to QGeoSearchManagerEngine::finished(), QGeoSearchManagerEngine::error(), QGeoSearchReply::finished() or QGeoSearchReply::error() with deleteLater().

This function was introduced in Qt Mobility 1.1.

QGeoSearchReply * QGeoSearchManagerEngine::search ( const QString & searchString, QGeoSearchManager::SearchTypes searchTypes, int limit, int offset, QGeoBoundingArea * bounds ) [virtual]

Begins searching for a place matching searchString. The value of searchTypes will determine whether the search is for addresses only, for landmarks only or for both.

A QGeoSearchReply 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 QGeoSearchReply object will emit signals indicating if the operation completes or if errors occur.

If supportsGeocoding() returns false and searchTypes is QGeoSearchManagerEngine::SearchGeocode an QGeoSearchReply::UnsupportedOptionError will occur.

Once the operation has completed, QGeoSearchReply::places() can be used to retrieve the results, which will consist of a list of QGeoPlace objects. These object represent a combination of coordinate and address data.

If any of the QGeoPlace instances in the results have landmark associated data, QGeoPlace::isLandmark() will return true and QLandmark::QLandmark(const QGeoPlace &place) can be used to convert the QGeoPlace instance into a QLandmark instance.

If searchTypes is QGeoSearchManagerEngine::SearchLandmarks or QGeoSearchManagerEngine::SearchAll, a free text landmark search will be performed. The results will be a combination of the backend specific landmark search and the same free text search applied to each of the QLandmarkManager instances in additionalLandmarkManagers().

Note: At present the additional landmark managers only search for the search string in the name of the landmarks.

If limit is -1 the entire result set will be returned, otherwise at most limit results will be returned.

The offset parameter is used to ask the search service to not return the first offset results.

The limit and offset results are used together to implement paging.

If additional landmark managers have been setup the number of results returned will be at most (1 + number of additional landmark managers) * limit. This happens because the results are requested from all sources, combined, and returned once all sources have responded.

If bounds is non-null and a valid QGeoBoundingArea it will be used to limit the results to those that are contained by bounds.

The user is responsible for deleting the returned reply object, although this can be done in the slot connected to QGeoSearchManagerEngine::finished(), QGeoSearchManagerEngine::error(), QGeoSearchReply::finished() or QGeoSearchReply::error() with deleteLater().

This function was introduced in Qt Mobility 1.1.

void QGeoSearchManagerEngine::setAdditionalLandmarkManagers ( const QList<QLandmarkManager *> & landmarkManagers )

Sets the landmark managers to be used with search() to landmarkManagers.

These landmark managers will be used along with the landmark manager returned by defaultLandmarkManager().

This function was introduced in Qt Mobility 1.1.

See also additionalLandmarkManagers().

void QGeoSearchManagerEngine::setDefaultLandmarkManager ( QLandmarkManager * landmarkManager ) [protected]

Sets the landmark manager provided by the service provider for use with search() to landmarkManager.

This should only be set if search() makes use of a QLandmarkManager instance to provide landmark searching functionality.

It is important that subclasses use this method to ensure that the engine is able to carry out landmark searches. If this function is not used the engine will not be able to use or return the default landmark manager.

This function was introduced in Qt Mobility 1.1.

See also defaultLandmarkManager().

void QGeoSearchManagerEngine::setLocale ( const QLocale & locale )

Sets the locale to be used by the this manager to locale.

If this search manager supports returning the results in different languages, they will be returned in the language of locale.

The locale used defaults to the system locale if this is not set.

This function was introduced in Qt Mobility 1.1.

See also locale().

void QGeoSearchManagerEngine::setSupportedSearchTypes ( QGeoSearchManager::SearchTypes searchTypes ) [protected]

Sets the search types supported by the search() with this engine to searchTypes.

It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support any search types.

This function was introduced in Qt Mobility 1.1.

See also supportedSearchTypes().

void QGeoSearchManagerEngine::setSupportsGeocoding ( bool supported ) [protected]

Sets whether geocoding is supported by this engine to supported.

It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support geocoding.

This function was introduced in Qt Mobility 1.1.

See also supportsGeocoding().

void QGeoSearchManagerEngine::setSupportsReverseGeocoding ( bool supported ) [protected]

Sets whether reverse geocoding is supported by this engine to supported.

It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support reverse geocoding.

This function was introduced in Qt Mobility 1.1.

See also supportsReverseGeocoding().

QGeoSearchManager::SearchTypes QGeoSearchManagerEngine::supportedSearchTypes () const

Returns the search types supported by the search() with this engine.

This function was introduced in Qt Mobility 1.1.

See also setSupportedSearchTypes().

bool QGeoSearchManagerEngine::supportsGeocoding () const

Returns whether this engine supports geocoding.

This function was introduced in Qt Mobility 1.1.

See also setSupportsGeocoding().

bool QGeoSearchManagerEngine::supportsReverseGeocoding () const

Returns whether this engine supports reverse geocoding.

This function was introduced in Qt Mobility 1.1.

See also setSupportsReverseGeocoding().