QPlaceManager¶

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

Synopsis¶

Functions¶

def category (categoryId)
def childCategories ([parentId=””])
def childCategoryIds ([parentId=””])
def compatiblePlace (place)
def getPlaceContent (request)
def getPlaceDetails (placeId)
def initializeCategories ()
def locales ()
def managerName ()
def managerVersion ()
def matchingPlaces (request)
def parentCategoryId (categoryId)
def removeCategory (categoryId)
def removePlace (placeId)
def saveCategory (category[, parentId=””])
def savePlace (place)
def search (query)
def searchSuggestions (request)
def setLocale (locale)
def setLocales (locale)

Signals¶

def categoryAdded (category, parentId)
def categoryRemoved (categoryId, parentId)
def categoryUpdated (category, parentId)
def dataChanged ()
def error (arg__1, error[, errorString=””])
def finished (reply)
def placeAdded (placeId)
def placeRemoved (placeId)
def placeUpdated (placeId)

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:

childCategories()

category()

parentCategoryId()

childCategoryIds() ;

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:

category – PySide2.QtLocation.QPlaceCategory
parentId – str

PySide2.QtLocation.QPlaceManager.categoryRemoved(categoryId, parentId)¶

Parameters:

categoryId – str
parentId – str

PySide2.QtLocation.QPlaceManager.categoryUpdated(category, parentId)¶

Parameters:

category – PySide2.QtLocation.QPlaceCategory
parentId – str

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:: place – PySide2.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:

arg__1 – PySide2.QtLocation.QPlaceReply
error – Error
errorString – str

PySide2.QtLocation.QPlaceManager.finished(reply)¶

Parameters:: reply – PySide2.QtLocation.QPlaceReply

PySide2.QtLocation.QPlaceManager.getPlaceContent(request)¶

Parameters:: request – PySide2.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.

Table of Contents

Previous topic

Next topic

QPlaceManager¶

Synopsis¶

Functions¶

Signals¶

Detailed Description¶

Obtaining a QPlaceManager Instance¶

Asynchronous Interface¶

Category Initialization¶

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.