|
|
              
PlaceSearchSuggestionModelThe PlaceSearchSuggestionModel element provides access to search term suggestions. More... Inherits QtObject This type was introduced in Qt Location 5.0. Properties
MethodsDetailed DescriptionThe PlaceSearchSuggestionModel can be used to provide search term suggestions as the user enters their search term. The properties of this model should match that of the PlaceSearchModel, which will be used to perform the actual search query, to ensure that the search suggestion results are relevant. There are two ways of accessing the data provided by this model, either through the suggestions property or through views and delegates. The latter is the preferred method. The offset and limit properties can be used to access paged suggestions. When the offset and limit properties are set the suggestions between offset and (offset + limit - 1) will be returned. Support for paging may vary from plugin to plugin. The model returns data for the following roles:
The following example shows how to use the PlaceSearchSuggestionModel to get suggested search terms from a partial search term. The searchArea is set to match what would be used to perform the actual place search with PlaceSearchModel. import QtQuick 2.0 import QtLocation 5.0 PlaceSearchSuggestionModel { id: suggestionModel plugin: myPlugin searchArea: BoundingCircle { center: Coordinate { // Brisbane longitude: 153.02778 latitude: -27.46778 } } onSearchTermChanged: update() } ListView { model: suggestionModel delegate: Text { text: suggestion } } See also PlaceSearchModel and QPlaceManager. Property DocumentationThis read-only property holds the textual presentation of latest search suggestion model error. If no error has occurred, or if the model was cleared, an empty string is returned. An empty string may also be returned if an error occurred which has no associated textual representation. This property holds the limit of the number of items that will be returned. See also offset. This property holds the search area. Search suggestion results returned by the model will be relevant to the given search area. If this property is set to a BoundingCircle its radius property may be left unset, in which case the Plugin will choose an appropriate radius for the search. This property holds the partial search term used in query. This property holds the status of the model. It can be one of:
This property holds the list of predicted search terms that the model currently has. Method DocumentationCancels an ongoing search suggestion operation. See also execute() and status. Resets the model. All search suggestions are cleared, any outstanding requests are aborted and possible errors are cleared. Model status will be set to PlaceSearchSuggestionModel.Null. Updates the model based on the provided query parameters. The model will be populated with a list of search suggestions for the partial searchTerm and searchArea. If the plugin supports it, other paramaters such as limit and offset may be specified. update() submits the set of parameters to the plugin to process. While the model is updating the status of the model is set to PlaceSearchSuggestionModel.Loading. If the model is successfully updated, the status is set to PlaceSearchSuggestionModel.Ready, while if it unsuccessfully completes, the status is set to PlaceSearchSuggestionModel.Error and the model cleared. This example shows use of the model BoundingCircle {
id: searchLocation
center: Coordinate {
latitude: 10
longitude: 10
}
}
PlaceSeachSuggestionModel {
id: model
plugin: backendPlugin
searchArea: searchLocation
...
}
MouseArea {
...
onClicked: {
model.searchTerm = "piz"
searchLocation.center.latitude = -27.5
searchLocation.cetner.longitude = 153
model.update();
}
}
A more detailed example can be found in the in places example. |
