QPlaceManager

The QPlaceManager class provides the interface which allows clients to access places stored in a particular backend. More

Inheritance diagram of PySide2.QtLocation.QPlaceManager

Synopsis

Functions

Signals

Detailed Description

The following table gives an overview of the functionality provided by the QPlaceManager

Functionality

Description

Searching for places

Using set of parameters such as a search term and search area, relevant places can be returned to the user.

Categories

Places can be classified as belonging to different categories. The manager supports access to these categories.

Search term suggestions

Given a partially complete search term, a list of potential search terms can be given.

Recommendations

Given an existing place, a set of similar recommended places can be suggested to the user.

Rich Content

Rich content such as images, reviews etc can be retrieved in a paged fashion.

Place or Category management

Places and categories may be saved and removed. It is possible for notifications to be given when this happens.

Localization

Different locales may be specified to return place data in different languages.

Obtaining a QPlaceManager Instance

Creation of a QPlaceManager is facilitated by the QGeoServiceProvider . See Initializing a manager for an example on how to create a manager.

Asynchronous Interface

The QPlaceManager class provides an abstraction of the datastore which contains place information. The functions provided by the QPlaceManager and primarily asynchronous and follow a request-reply model. Typically a request is given to the manager, consisting of a various set of parameters and a reply object is created. The reply object has a signal to notify when the request is done, and once completed, the reply contains the results of the request, along with any errors that occurred, if any.

An asynchronous request is generally handled as follows:

        //1) Make an appropriate request
        QPlaceSearchRequest searchRequest;
        searchRequest.setSearchTerm("ice cream");
        searchRequest.setSearchArea(QGeoCircle(QGeoCoordinate(12.34, 56.78)));

        //2) Use the manager to initiate a request and retrieve a reply object
        QPlaceSearchReply * searchReply = manager->search(searchRequest);

        //3) Connect the reply object to a slot which is invoked upon operation completion
        connect(searchReply, SIGNAL(finished()), this, SLOT(processSearchReply()));
    ...
    ...
<Code snippet "places/requesthandler.h:Simple search handler" not found>

See Common Operations for a list of examples demonstrating how the QPlaceManger is used.

Category Initialization

Sometime during startup of an application, the initializeCategories() function should be called to setup the categories. Initializing the categories enables the usage of the following functions:

If the categories need to be refreshed or reloaded, the initializeCategories() function may be called again.

class PySide2.QtLocation.QPlaceManager
PySide2.QtLocation.QPlaceManager.category(categoryId)
Parameters

categoryId – str

Return type

PySide2.QtLocation.QPlaceCategory

Returns the category corresponding to the given categoryId .

PySide2.QtLocation.QPlaceManager.categoryAdded(category, parentId)
Parameters
PySide2.QtLocation.QPlaceManager.categoryRemoved(categoryId, parentId)
Parameters
  • categoryId – str

  • parentId – str

PySide2.QtLocation.QPlaceManager.categoryUpdated(category, parentId)
Parameters
PySide2.QtLocation.QPlaceManager.childCategories([parentId=""])
Parameters

parentId – str

Return type

Returns a list of categories that are children of the category corresponding to parentId . If parentId is empty, all the top level categories are returned.

PySide2.QtLocation.QPlaceManager.childCategoryIds([parentId=""])
Parameters

parentId – str

Return type

list of strings

Returns the child category identifiers of the category corresponding to parentId . If parentId is empty then all top level category identifiers are returned.

PySide2.QtLocation.QPlaceManager.compatiblePlace(place)
Parameters

placePySide2.QtLocation.QPlace

Return type

PySide2.QtLocation.QPlace

Returns a pruned or modified version of the original place which is suitable to be saved into this manager.

Only place details that are supported by this manager is present in the modified version. Manager specific data such as the place id, is not copied over from the original .

PySide2.QtLocation.QPlaceManager.dataChanged()
PySide2.QtLocation.QPlaceManager.error(arg__1, error[, errorString=""])
Parameters
PySide2.QtLocation.QPlaceManager.finished(reply)
Parameters

replyPySide2.QtLocation.QPlaceReply

PySide2.QtLocation.QPlaceManager.getPlaceContent(request)
Parameters

requestPySide2.QtLocation.QPlaceContentRequest

Return type

PySide2.QtLocation.QPlaceContentReply

Retrieves content for a place according to the parameters specified in request .

See Fetching Rich Content for an example of usage.

PySide2.QtLocation.QPlaceManager.getPlaceDetails(placeId)
Parameters

placeId – str

Return type

PySide2.QtLocation.QPlaceDetailsReply

Retrieves a details of place corresponding to the given placeId .

See Fetching Place Details for an example of usage.

PySide2.QtLocation.QPlaceManager.initializeCategories()
Return type

PySide2.QtLocation.QPlaceReply

Initializes the categories of the manager.

See Using Categories for an example of usage.

PySide2.QtLocation.QPlaceManager.locales()
Return type

Returns a list of preferred locales. The locales are used as a hint to the manager for what language place and category details should be returned in.

If the first specified locale cannot be accommodated, the manager falls back to the next and so forth. Some manager backends may not support a set of locales which are rigidly defined. An arbitrary example is that some places in France could have French and English localizations, while certain areas in America may only have the English localization available. In this example, the set of supported locales is context dependent on the search location.

If the manager cannot accommodate any of the preferred locales, the manager falls back to using a supported language that is backend specific.

Support for locales may vary from provider to provider. For those that do support it, by default, the global default locale is set as the manager’s only locale.

For managers that do not support locales, the locale list is always empty.

See also

setLocales()

PySide2.QtLocation.QPlaceManager.managerName()
Return type

str

Returns the name of the manager

PySide2.QtLocation.QPlaceManager.managerVersion()
Return type

int

Returns the manager version.

PySide2.QtLocation.QPlaceManager.matchingPlaces(request)
Parameters

requestPySide2.QtLocation.QPlaceMatchRequest

Return type

PySide2.QtLocation.QPlaceMatchReply

Returns a reply which contains a list of places which correspond/match those specified in the request . The places specified in the request come from a different manager.

PySide2.QtLocation.QPlaceManager.parentCategoryId(categoryId)
Parameters

categoryId – str

Return type

str

Returns the parent category identifier of the category corresponding to categoryId .

PySide2.QtLocation.QPlaceManager.placeAdded(placeId)
Parameters

placeId – str

PySide2.QtLocation.QPlaceManager.placeRemoved(placeId)
Parameters

placeId – str

PySide2.QtLocation.QPlaceManager.placeUpdated(placeId)
Parameters

placeId – str

PySide2.QtLocation.QPlaceManager.removeCategory(categoryId)
Parameters

categoryId – str

Return type

PySide2.QtLocation.QPlaceIdReply

Removes the category corresponding to categoryId from the manager.

See Removing a category for an example of usage.

PySide2.QtLocation.QPlaceManager.removePlace(placeId)
Parameters

placeId – str

Return type

PySide2.QtLocation.QPlaceIdReply

Removes the place corresponding to placeId from the manager.

See Removing a place cpp for an example of usage.

PySide2.QtLocation.QPlaceManager.saveCategory(category[, parentId=""])
Parameters
Return type

PySide2.QtLocation.QPlaceIdReply

Saves a category that is a child of the category specified by parentId . An empty parentId means category is saved as a top level category.

See Saving a category for an example of usage.

PySide2.QtLocation.QPlaceManager.savePlace(place)
Parameters

placePySide2.QtLocation.QPlace

Return type

PySide2.QtLocation.QPlaceIdReply

Saves a specified place .

See Saving a place cpp for an example of usage.

PySide2.QtLocation.QPlaceManager.search(query)
Parameters

queryPySide2.QtLocation.QPlaceSearchRequest

Return type

PySide2.QtLocation.QPlaceSearchReply

Searches for places according to the parameters specified in request .

See Discovery/Search for an example of usage.

PySide2.QtLocation.QPlaceManager.searchSuggestions(request)
Parameters

requestPySide2.QtLocation.QPlaceSearchRequest

Return type

PySide2.QtLocation.QPlaceSearchSuggestionReply

Requests a set of search term suggestions according to the parameters specified in request . The request can hold the incomplete search term, along with other data such as a search area to narrow down relevant results.

See Search Suggestions for an example of usage.

PySide2.QtLocation.QPlaceManager.setLocale(locale)
Parameters

localePySide2.QtCore.QLocale

Convenience function which sets the manager’s list of preferred locales to a single locale .

PySide2.QtLocation.QPlaceManager.setLocales(locale)
Parameters

locale

Set the list of preferred locales .

See also

locales()