PySide6.QtLocation.QPlaceSearchRequest

class QPlaceSearchRequest

QPlaceSearchRequest 类表示搜索请求的参数集。更多…

概要

方法

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述

警告

本节包含从C++自动翻译到Python的代码片段，可能包含错误。

一个典型的搜索请求可能如下所示：

        searchRequest = QPlaceSearchRequest()
        searchRequest.setSearchTerm("Fast food") #search term for what we are interested in
        #set a search center
        searchRequest.setSearchArea(QGeoCircle(QGeoCoordinate(2.3, 48.87)))
        #set a distance hint as a relevancy hint.
        #closer places have greater weighting in the ranking of results.
        searchRequest.setRelevanceHint(QPlaceSearchRequest.DistanceHint)
        #use limit to adjust pagination.
        #this limits the number of place results to 5 per page.
        searchRequest.setLimit(5)
        #provide some categories to narrow down search
categories = QList()
        categories << diner << restaurant
        searchRequest.setCategories(categories)

请注意，可以通过设置一个具有中心但没有半径的圆形搜索区域来指定搜索中心。默认半径设置为-1，表示未定义的半径。提供者将解释为可以自由选择其自己的默认半径。

QPlaceSearchRequest 主要用于与 QPlaceManager 一起 search for places，但它也用于提供参数以 generating search term suggestions。请注意，在此上下文中，只有部分参数可能是相关的。例如，搜索区域有助于缩小相关搜索建议的范围，而其他参数如相关性提示则不适用。

还需注意，不同的提供者可能支持的参数不同，例如一些提供者可能不支持分页，而其他提供者则支持；一些提供者可能会考虑相关性提示，而其他提供者可能会完全忽略它们，详情请参阅插件文档。

class RelevanceHint

定义提示以帮助排名地点结果。

常量

描述

QPlaceSearchRequest.UnspecifiedHint

未指定明确的提示。

QPlaceSearchRequest.DistanceHint

距离搜索中心的相关性对用户很重要。较近的地点权重更高。此提示仅在查询中使用圆形搜索区域时有用。

QPlaceSearchRequest.LexicalPlaceNameHint

根据名称的字母顺序排列地点对用户来说是相关的。
__init__()

默认构造函数。构造一个新的请求对象。

__init__(other)
Parameters:

其他 – QPlaceSearchRequest

构造other的副本。

categories()
Return type:

QPlaceCategory的列表

返回搜索请求中要使用的类别。地点只需要属于其中一个类别即可被视为匹配。

另请参阅

setCategories()

clear()

清除搜索请求。

limit()
Return type:

整数

返回要检索的搜索结果的最大数量。

limit的负值意味着它是未定义的。由后端提供者选择返回适当数量的结果。默认的limit是-1。

另请参阅

setLimit()

__ne__(rhs)
Parameters:

rhs – QPlaceSearchRequest

Return type:

布尔

如果 lhs 不等于 rhs，则返回 true，否则返回 false。

__eq__(rhs)
Parameters:

rhs – QPlaceSearchRequest

Return type:

布尔

如果 lhs 等于 rhs，则返回 true，否则返回 false。

recommendationId()
Return type:

字符串

返回将用于搜索类似地点推荐的地点ID。

另请参阅

setRecommendationId()

relevanceHint()
Return type:

RelevanceHint

返回请求的相关性提示。该提示提供给提供者以帮助但不强制规定结果的排名。例如，提供距离提示可能会使较近的地点获得更高的排名，但这并不一定意味着结果将严格按照距离排序。

另请参阅

setRelevanceHint()

searchArea()
Return type:

QGeoShape

返回将用于限制搜索结果的搜索区域。默认的搜索区域是一个无效的QGeoShape，表示没有定义特定的搜索区域。

另请参阅

setSearchArea()

searchContext()
Return type:

对象

返回与此地点搜索请求相关的后端特定附加搜索上下文。搜索上下文通常作为proposed search results的一部分设置。

另请参阅

setSearchContext()

searchTerm()
Return type:

字符串

返回搜索词。

另请参阅

setSearchTerm()

setCategories(categories)
Parameters:

categories – QPlaceCategory 的列表

设置搜索请求以从给定的categories列表中搜索。在搜索期间返回的任何地点将至少匹配其中一个categories。

setCategory(category)
Parameters:

类别 – QPlaceCategory

将搜索请求设置为按单个category进行搜索

另请参阅

setCategories()

setLimit(limit)
Parameters:

limit – int

设置要检索的搜索结果的最大数量为limit。

另请参阅

limit()

setRecommendationId(recommendationId)
Parameters:

recommendationId – str

设置将用于搜索推荐的placeId。

另请参阅

recommendationId()

setRelevanceHint(hint)
Parameters:

提示 – RelevanceHint

设置搜索地点时使用的相关性hint。

另请参阅

relevanceHint()

setSearchArea(area)
Parameters:

区域 – QGeoShape

设置搜索请求以在给定的area内进行搜索。

另请参阅

searchArea()

setSearchContext(context)
Parameters:

上下文 – 对象

将搜索上下文设置为 context。

注意

此方法旨在由地理服务插件在返回类型为ProposedSearchResult的搜索结果时使用。

搜索上下文由后端用于存储与搜索请求相关的额外搜索上下文。其他相关字段也应填写。例如，如果搜索上下文编码了文本搜索，还应使用setSearchTerm()设置搜索词。搜索上下文允许保留无法直接通过Qt Location API访问的额外搜索上下文。

搜索上下文可以是任何可存储在QVariant中的类型。搜索上下文的值不打算直接由应用程序使用。

另请参阅

searchContext()

setSearchTerm(term)
Parameters:

term – 字符串

设置搜索term。

另请参阅

searchTerm()

swap(other)
Parameters:

其他 – QPlaceSearchRequest