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
検索リクエストで使われるカテゴリーを返します。場所がリクエストによってマッチするとみなされるためには、カテゴリの1つに属していればよい。
setCategories()も参照してください 。
void QPlaceSearchRequest::clear()
検索リクエストをクリアします。
int QPlaceSearchRequest::limit() const
検索結果の最大数を返します。
limit に負の値を指定すると、未定義であることを意味します。適切な数の結果を返すかどうかはバックエンドプロバイダに任されています。デフォルトの limit は -1 です。
setLimit()も参照 ください。
QString QPlaceSearchRequest::recommendationId() const
場所 ID を返します。この 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 の少なくとも 1 つにマッチします。
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)
場所を検索するときに使用する可視性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 と等しくなければ真を返し、そうでなければ偽を返す。
[noexcept]
bool operator==(const QPlaceSearchRequest &lhs, const QPlaceSearchRequest &rhs)
lhs がrhs と等しい場合は true を返し、そうでない場合は false を返します。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。