QPlaceSearchRequest Class
QPlaceSearchRequestクラスは、検索リクエストのパラメータセットを表します。詳細...
Header: | #include <QPlaceSearchRequest> |
qmake: | QT += location |
パブリックな型
enum | RelevanceHint { UnspecifiedHint, DistanceHint, LexicalPlaceNameHint } |
パブリック関数
QPlaceSearchRequest() | |
QPlaceSearchRequest(const QPlaceSearchRequest &other) | |
~QPlaceSearchRequest() | |
QList<QPlaceCategory> | categories() const |
void | clear() |
int | limit() const |
QString | recommendationId() const |
QPlaceSearchRequest::RelevanceHint | relevanceHint() const |
QGeoShape | searchArea() const |
QVariant | searchContext() const |
QString | searchTerm() const |
void | setCategories(const QList<QPlaceCategory> &categories) |
void | setCategory(const QPlaceCategory &category) |
void | setLimit(int limit) |
void | setRecommendationId(const QString &placeId) |
void | setRelevanceHint(QPlaceSearchRequest::RelevanceHint hint) |
void | setSearchArea(const QGeoShape &area) |
void | setSearchContext(const QVariant &context) |
void | setSearchTerm(const QString &term) |
void | setVisibilityScope(QLocation::VisibilityScope scope) |
QLocation::VisibilityScope | visibilityScope() const |
QPlaceSearchRequest & | operator=(const QPlaceSearchRequest &other) |
関連する非メンバー
bool | operator!=(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs) |
bool | operator==(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 からsearch for places で使用されるが、generating search term suggestions のパラメータを提供するためにも使用される。このコンテキストでは、パラメータの一部だけが関連する可能性があることに注意してください。例えば、検索領域は関連する検索候補を絞り込むのに有用であるが、関連性のヒントなど他のパラメータはあまり当てはまらない。
また、プロバイダによってサポートするパラメータが異なることに注意してください。例えば、ページングをサポートしないプロバイダもあれば、ページングをサポートするプロバイダもあります。
メンバータイプのドキュメント
enum QPlaceSearchRequest::RelevanceHint
順位付けのためのヒントを定義します。
定数 | 値 | 説明 |
---|---|---|
QPlaceSearchRequest::UnspecifiedHint | 0 | 明示的なヒントは指定されていません。 |
QPlaceSearchRequest::DistanceHint | 1 | 検索中心までの距離は、ユーザーに関連します。より近い場所は、より高く重み付けされます。このヒントは、クエリで円形の検索エリアが使用されている場合にのみ有効です。 |
QPlaceSearchRequest::LexicalPlaceNameHint | 2 | 名前による場所のアルファベット順は、ユーザーに関係する。 |
メンバー関数ドキュメント
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 に負の値を指定すると、未定義であることを意味します。適切な件数を返すかどうかはバックエンドプロバイダに一任されます。デフォルトの limit は -1 です。
setLimit()も参照 ください。
QString QPlaceSearchRequest::recommendationId() const
似たような場所のおすすめを検索するために使われる場所 ID を返します。
setRecommendationId()も参照ください 。
QPlaceSearchRequest::RelevanceHint QPlaceSearchRequest::relevanceHint() const
リクエストの関連性のヒントを返します。このヒントは、結果の順位付けを決定するものではありません。例えば、距離のヒントを提供することで、より近い場所をより高い順位にすることができますが、必ずしも結果が距離に従って厳密に並べられることを意味するわけではありません。
setRelevanceHint()も参照 。
QGeoShape QPlaceSearchRequest::searchArea() const
検索結果を制限するために使用される検索エリアを返す。デフォルトの検索領域は無効なQGeoShape で、特定の検索領域が定義されていないことを示す。
setSearchArea()も参照 。
QVariant QPlaceSearchRequest::searchContext() const
このプレイス検索リクエストに関連付けられた、バックエンド固有の追加検索コンテキストを返す。検索コンテキストは通常、proposed search results の一部として設定されます。
setSearchContext()も参照ください 。
QString QPlaceSearchRequest::searchTerm() const
検索語を返す。
setSearchTerm()も参照 。
void QPlaceSearchRequest::setCategories(const QList<QPlaceCategory> &categories)
与えられたcategories のリストから検索するように検索リクエストを設定する。検索中に返された場所は、categories の少なくともひとつにマッチします。
categories() およびsetCategory()も参照 。
void QPlaceSearchRequest::setCategory(const QPlaceCategory &category)
で検索するように検索リクエストを設定します。category
setCategories()も参照 。
void QPlaceSearchRequest::setLimit(int limit)
検索結果の最大取得数をlimit に設定する。
limit()も参照のこと 。
void QPlaceSearchRequest::setRecommendationId(const QString &placeId)
おすすめの検索に使われるplaceId を設定する。
recommendationId()も参照 。
void QPlaceSearchRequest::setRelevanceHint(QPlaceSearchRequest::RelevanceHint hint)
場所を検索する際に使用する関連度hint を設定する。
relevanceHint()も参照 。
void QPlaceSearchRequest::setSearchArea(const QGeoShape &area)
与えられたarea 内を検索するように検索リクエストを設定する。
searchArea()も参照 。
void QPlaceSearchRequest::setSearchContext(const QVariant &context)
検索コンテキストをcontext に設定する。
注: このメソッドは、QPlaceSearchResult::ProposedSearchResult タイプの検索結果を返すときにジオサービスプラグインが使用することを想定しています。
検索コンテキストは、検索リクエストに関連する追加の検索コンテキストを保存するためにバックエンドによって使用されます。他の関連するフィールドも埋められるべきである。例えば、検索コンテキストがテキスト検索をエンコードする場合、検索用語もsetSearchTerm() で設定されるべきである。検索コンテキストによって、Qt Location APIから直接アクセスできない追加の検索コンテキストを保持することができる。
検索コンテキストは、QVariant に格納可能な任意の型とすることができる。 検索コンテキストの値は、アプリケーションから直接使用することは意図されていない。
searchContext()も参照 。
void QPlaceSearchRequest::setSearchTerm(const QString &term)
検索を設定するterm 。
searchTerm()も参照 。
void QPlaceSearchRequest::setVisibilityScope(QLocation::VisibilityScope scope)
場所を検索するときに使用する visibilityscope を設定する。
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 と等しくなければ真を返し、そうでなければ偽を返す。
[noexcept]
bool operator==(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)
lhs がrhs と等しければ真を返し、そうでなければ偽を返す。
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.