QPlaceSearchRequest 类

QPlaceSearchRequest 类表示搜索请求的参数集合。 更多信息...

头文件 #include <QPlaceSearchRequest>
qmakeQT += location

公共类型

枚举RelevanceHint { UnspecifiedHint, DistanceHint, LexicalPlaceNameHint }

公共函数

QPlaceSearchRequest()
QPlaceSearchRequest(const QPlaceSearchRequest &other)
~QPlaceSearchRequest()
QList<QPlaceCategory>categories() const
voidclear()
intlimit() const
QStringrecommendationId() const
QPlaceSearchRequest::RelevanceHintrelevanceHint() const
QGeoShapesearchArea() const
QVariantsearchContext() const
QStringsearchTerm() const
voidsetCategories(const QList<QPlaceCategory> &categories)
voidsetCategory(const QPlaceCategory &category)
voidsetLimit(int limit)
voidsetRecommendationId(const QString &placeId)
voidsetRelevanceHint(QPlaceSearchRequest::RelevanceHint hint)
voidsetSearchArea(const QGeoShape &area)
voidsetSearchContext(const QVariant &context)
voidsetSearchTerm(const QString &term)
voidsetVisibilityScope(QLocation::VisibilityScope scope)
QLocation::VisibilityScopevisibilityScope() const
QPlaceSearchRequest &operator=(const QPlaceSearchRequest &other)
booloperator!=(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)
booloperator==(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)

详细描述

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

QPlaceSearchRequest searchRequest;
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
QList<QPlaceCategory> categories;
categories << diner << restaurant;
searchRequest.setCategories(categories);

请注意,可以通过设置有中心但无半径的圆形搜索区域来完成指定搜索中心。默认半径设置为 -1,表示未定义的半径。提供商将将此解释为可以选择自己的默认半径。

QPlaceSearchRequest 主要用于与 QPlaceManager 结合使用进行地点搜索,但也可以用于提供生成搜索词建议的参数。请注意,在此上下文中,只有一些参数可能相关。例如,搜索区域对于缩小相关搜索建议范围很有用,而其他参数,如相关性提示,则不太适用。

请注意,供应商支持的参数可能有所不同,例如,一些供应商可能不支持分页,而另一些则支持;一些供应商可能重视相关性提示,而另一些则可能完全忽略它们。有关更多详细信息,请参阅插件文档

成员类型文档

枚举 QPlaceSearchRequest::RelevanceHint

定义辅助信息以帮助排列地点结果。

常量描述
QPlaceSearchRequest::UnspecifiedHint0未指定任何显式提示。
QPlaceSearchRequest::DistanceHint1搜索中心到距离对于用户来说是相关的。较近的地点更重要。此提示仅在查询中使用圆形搜索区域时才有效。
QPlaceSearchRequest::LexicalPlaceNameHint2根据名称对地点的字母顺序排列对于用户来说是相关的。

成员函数文档

QPlaceSearchRequest::QPlaceSearchRequest()

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

[noexcept] QPlaceSearchRequest::QPlaceSearchRequest(const QPlaceSearchRequest &other)

构建 other 的副本。

[noexcept] QPlaceSearchRequest::~QPlaceSearchRequest()

销毁请求对象。

QList<QPlaceCategory> QPlaceSearchRequest::categories() const

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

另请参阅setCategories

void QPlaceSearchRequest::clear()

清除搜索请求。

int QPlaceSearchRequest::limit() const

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

对于limit的负值意味着这是未定义的。这留给后端供应商选择返回适当结果数。默认限制为-1。

另请参阅setLimit

QString QPlaceSearchRequest::recommendationId() const

返回用于搜索类似地点的建议的地点id。

另请参阅setRecommendationId

QPlaceSearchRequest::RelevanceHint QPlaceSearchRequest::relevanceHint() const

返回请求的相关性提示。提示被提供以帮助,但不指定结果排名。例如,提供距离提示可能使较近的地点排名较高,但这并不意味着结果将严格按距离排序。

另请参阅setRelevanceHint

QGeoShape QPlaceSearchRequest::搜索区域() const

返回用于限制搜索结果的搜索区域。默认的搜索区域是无效的 QGeoShape,表示未定义特定的搜索区域。

另请参阅设置搜索区域

QVariant QPlaceSearchRequest::搜索上下文() const

返回与该地点搜索请求关联的后端特定的额外搜索上下文。搜索上下文通常是作为建议搜索结果的一部分设置的。

另请参阅设置搜索上下文

QString QPlaceSearchRequest::搜索词() const

返回搜索词。

另请参阅设置搜索词

void QPlaceSearchRequest::设置类别(const QList<QPlaceCategory> &categories)

将搜索请求设置为从给定的类别列表中进行搜索。搜索过程中返回的任何地点至少与其中一个类别匹配。

另请参阅类别设置类别

void QPlaceSearchRequest::设置类别(const QPlaceCategory &category)

将搜索请求设置为使用单一类别进行搜索。

另请参阅setCategories

void QPlaceSearchRequest::设置限制(int limit)

设置要检索的搜索结果的最大数量为限制

另请参阅限制

void QPlaceSearchRequest::设置推荐ID(const QString &placeId)

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

另请参阅推荐ID

void QPlaceSearchRequest::设置相关提示(QPlaceSearchRequest::RelevanceHint hint)

设置在搜索地点时使用的相关提示

另请参阅相关提示

void QPlaceSearchRequest::设置搜索区域(const QGeoShape &area)

将搜索请求设置为在给定的区域内搜索。

另请参阅搜索区域

void QPlaceSearchRequest::设置搜索上下文(const QVariant &context)

将搜索上下文设置为上下文

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

搜索上下文由后端用于存储与搜索请求相关的附加搜索上下文。还应填写其他相关字段。例如,如果搜索上下文中编入了文本搜索,则应通过 setSearchTerm() 设置搜索词。搜索上下文允许保留通过 Qt 位置 API 无法直接访问的附加搜索上下文。

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

另请参阅searchContext

void QPlaceSearchRequest::setSearchTerm(const QString &term)

设置搜索

另请参阅searchTerm

void QPlaceSearchRequest::setVisibilityScope(QLocation::VisibilityScope scope)

设置在搜索地点时使用的可见性 范围

另请参阅visibilityScope

QLocation::VisibilityScope QPlaceSearchRequest::visibilityScope() const

返回在搜索地点时使用的可见性范围。默认值是 QLocation::UnspecifiedVisibility,这意味着没有分配显式范围。搜索期间可能返回任何范围的地点。

另请参阅setVisibilityScope

[noexcept] QPlaceSearchRequest &QPlaceSearchRequest::operator=(const QPlaceSearchRequest &other)

other 分配给此搜索请求,并返回对此搜索请求的引用。

相关非成员

[noexcept] bool operator!=(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)

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

[noexcept] bool operator==(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)

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

© 2024 Qt 公司有限公司。此处包含的文档贡献是各自版权所有者的版权。此处提供的文档是根据自由软件基金会发布的 GNU 自由文档许可证 1.3 版本 的条款许可的。Qt 及其相应标志是芬兰以及/或全球其他国家的 Qt 公司有限公司的商标。所有其他商标均为其各自所有者的财产。