QPlaceManagerEngine Class
QPlaceManagerEngine クラスは、プレイス機能へのアクセスを提供したいQGeoServiceProvider プラグインの実装者のためのインターフェイスを提供します。詳細...
Header: | #include <QPlaceManagerEngine> |
qmake: | QT += location |
Inherits: | QObject |
パブリック関数
QPlaceManagerEngine(const QVariantMap ¶meters, QObject *parent = nullptr) | |
virtual | ~QPlaceManagerEngine() |
virtual QPlaceCategory | category(const QString &categoryId) const |
virtual QList<QPlaceCategory> | childCategories(const QString &parentId) const |
virtual QStringList | childCategoryIds(const QString &categoryId) const |
virtual QPlace | compatiblePlace(const QPlace &original) const |
virtual QUrl | constructIconUrl(const QPlaceIcon &icon, const QSize &size) const |
virtual QPlaceContentReply * | getPlaceContent(const QPlaceContentRequest &request) |
virtual QPlaceDetailsReply * | getPlaceDetails(const QString &placeId) |
virtual QPlaceReply * | initializeCategories() |
virtual QList<QLocale> | locales() const |
QString | managerName() const |
int | managerVersion() const |
virtual QPlaceMatchReply * | matchingPlaces(const QPlaceMatchRequest &request) |
virtual QString | parentCategoryId(const QString &categoryId) const |
virtual QPlaceIdReply * | removeCategory(const QString &categoryId) |
virtual QPlaceIdReply * | removePlace(const QString &placeId) |
virtual QPlaceIdReply * | saveCategory(const QPlaceCategory &category, const QString &parentId) |
virtual QPlaceIdReply * | savePlace(const QPlace &place) |
virtual QPlaceSearchReply * | search(const QPlaceSearchRequest &request) |
virtual QPlaceSearchSuggestionReply * | searchSuggestions(const QPlaceSearchRequest &request) |
virtual void | setLocales(const QList<QLocale> &locales) |
シグナル
void | categoryAdded(const QPlaceCategory &category, const QString &parentId) |
void | categoryRemoved(const QString &categoryId, const QString &parentId) |
void | categoryUpdated(const QPlaceCategory &category, const QString &parentId) |
void | dataChanged() |
void | errorOccurred(QPlaceReply *reply, QPlaceReply::Error error, const QString &errorString = QString()) |
void | finished(QPlaceReply *reply) |
void | placeAdded(const QString &placeId) |
void | placeRemoved(const QString &placeId) |
void | placeUpdated(const QString &placeId) |
保護された関数
QPlaceManager * | manager() const |
詳細説明
注意: バックエンドのクラスはソースやバイナリの互換性が保証されていません。APIは開発されたQtのバージョンでのみ動作が保証されています。API の変更はマイナーリリースでのみ行われます。(6.6 や 6.7 など)。
アプリケーション開発者はQPlaceManagerEngineを気にする必要はありません。しかし、バックエンドの実装者はQPlaceManagerEngineから派生し、抽象仮想関数の実装を提供する必要があります。
バックエンドの記述の詳細については、Places Backendドキュメントを参照してください。
QPlaceManagerも参照してください 。
メンバ関数のドキュメント
[explicit]
QPlaceManagerEngine::QPlaceManagerEngine(const QVariantMap ¶meters, QObject *parent = nullptr)
指定されたparent で新しいエンジンを構築します。parameters を使用して、エンジンに実装固有のデータを渡します。
[virtual noexcept]
QPlaceManagerEngine::~QPlaceManagerEngine()
このエンジンを破棄します。
[virtual]
QPlaceCategory QPlaceManagerEngine::category(const QString &categoryId) const
指定されたcategoryId に対応するカテゴリを返します。
[signal]
void QPlaceManagerEngine::categoryAdded(const QPlaceCategory &category, const QString &parentId)
このシグナルは、category がマネージャ・エンジンのデータストアに追加された場合に発行されます。category の親はparentId で指定されます。
このシグナルは、QPlaceManager::NotificationsFeature をサポートするマネージャエンジンのみが発行します。
dataChanged()も参照してください 。
[signal]
void QPlaceManagerEngine::categoryRemoved(const QString &categoryId, const QString &parentId)
このシグナルは、categoryId に対応するカテゴリがマネージャエンジンのデータストアから削除されたときに発行されます。削除されたカテゴリの親はparentId で指定されます。
このシグナルは、QPlaceManager::NotificationsFeature をサポートするマネージャエンジンのみが発行します。
dataChanged()も参照してください 。
[signal]
void QPlaceManagerEngine::categoryUpdated(const QPlaceCategory &category, const QString &parentId)
このシグナルは、マネージャエンジンのデータストアでcategory が変更された場合に発行されます。変更されたカテゴリの親はparentId で指定されます。
このシグナルは、QPlaceManager::NotificationsFeature をサポートするマネージャエンジンのみが発行します。
dataChanged()も参照してください 。
[virtual]
QList<QPlaceCategory> QPlaceManagerEngine::childCategories(const QString &parentId) const
parentId に対応するカテゴリの子であるカテゴリのリストを返します。parentId が空の場合、すべてのトップレベルカテゴリが返されます。
[virtual]
QStringList QPlaceManagerEngine::childCategoryIds(const QString &categoryId) const
categoryId に対応するカテゴリの子カテゴリ識別子を返します。categoryId が空の場合、すべてのトップ・レベル・カテゴリ識別子が返されます。
[virtual]
QPlace QPlaceManagerEngine::compatiblePlace(const QPlace &original) const
マネージャー・エンジンが保存するのに適した、original プレースの刈り込みまたは修正されたバージョンを返します。
このマネージャによってサポートされる場所の詳細のみが、修正されたバージョンに存在します。プレース ID のようなマネージャ固有のデータは、original からコピーされません。
[virtual]
QUrl QPlaceManagerEngine::constructIconUrl(const QPlaceIcon &icon, const QSize &size) const
QUrl QPlaceManagerEngine::constructIconUrl(const &icon, const &size)QPlaceIcon QSize
与えられたicon,size からアイコン URL を構築します。指定されたパラメータに最も近いアイコン画像の URL が返されます。
[signal]
void QPlaceManagerEngine::dataChanged()
*
このシグナルは、基礎となるデータストアに大規模な変更があり、クライアントがすべてのデータを再読み込みする必要があるほど急激な変更であるとエンジンが判断した場合に、エンジンによって発行されます。
このシグナルが発行された場合、関連する変更に対して他のシグナルは発行されません。
[signal]
void QPlaceManagerEngine::errorOccurred(QPlaceReply *reply, QPlaceReply::Error error, const QString &errorString = QString())
このシグナルは、reply の処理でエラーが検出されたときに発行されます。 おそらく、QPlaceManager::finished() シグナルがそれに続くでしょう。
エラーはエラーコードerror で示される。errorString が空でない場合は、エンド・ユーザー向けではなく、開発者向けのエラーのテキス ト説明が含まれます。
このシグナルとQPlaceReply::errorOccurred() は同時に発生する。
注意: このシグナルに接続されたスロット内のreply オブジェクトを削除しないでください。代わりにdeleteLater() を使用してください。
[signal]
void QPlaceManagerEngine::finished(QPlaceReply *reply)
このシグナルは、reply の処理が終了したときに発せられます。
reply->error() がQPlaceReply::NoError と等しい場合、処理は正常に終了しています。
このシグナルとQPlaceReply::finished() は同時に発せられる。
注意: このシグナルに接続されているスロットのreply オブジェクトを削除しないでください。代わりにdeleteLater() を使用する。
[virtual]
QPlaceContentReply *QPlaceManagerEngine::getPlaceContent(const QPlaceContentRequest &request)
request で指定されたパラメータに従って、場所の内容を取得する。
[virtual]
QPlaceDetailsReply *QPlaceManagerEngine::getPlaceDetails(const QString &placeId)
与えられたplaceId に対応する場所の詳細を取得する。
[virtual]
QPlaceReply *QPlaceManagerEngine::initializeCategories()
マネージャエンジンのカテゴリを初期化します。
[virtual]
QList<QLocale> QPlaceManagerEngine::locales() const
優先ロケールのリストを返します。ロケールは、場所とカテゴリの詳細がどの言語で返されるべきかの、マネージャエンジンへのヒントとして使用されます。
最初に指定されたロケールに対応できない場合、マネージャーエンジンは次のロケールにフォールバックします。
ロケールのサポートはプロバイダによって異なります。ロケールをサポートしているプロバイダでは、デフォルトでglobal default locale が使用されます。マネージャエンジンにロケールが割り当てられていない場合、グローバルデフォルトロケールを暗黙的に使用します。ロケールをサポートしていないエンジンでは、ロケール一覧は常に空になります。
setLocales()も参照 ください。
[protected]
QPlaceManager *QPlaceManagerEngine::manager() const
このエンジンの作成に使用したマネージャのインスタンスを返します。
QString QPlaceManagerEngine::managerName() const
このエンジンの実装が、他のプラグインが提供する実装と区別するために使用する名前を返します。
マネージャー名は、QGeoServiceProviderFactory::providerName() と同じになるように自動的に設定されます。
int QPlaceManagerEngine::managerVersion() const
このエンジン実装のバージョンを返します。
マネージャーバージョンは、自動的に QGeoServiceProviderFactory::providerVersion() と同じに設定されます。
[virtual]
QPlaceMatchReply *QPlaceManagerEngine::matchingPlaces(const QPlaceMatchRequest &request)
request で指定された場所に対応/一致する場所のリストを含む応答を返します。
[virtual]
QString QPlaceManagerEngine::parentCategoryId(const QString &categoryId) const
categoryId に対応するカテゴリーの親カテゴリー識別子を返す。
[signal]
void QPlaceManagerEngine::placeAdded(const QString &placeId)
このシグナルは、プレイスがマネージャエンジンのデータストアに追加された場合に発行されます。追加された特定のプレイスはplaceId で指定されます。
このシグナルは、QPlaceManager::NotificationsFeature をサポートするマネージャエンジンのみが発行します。
dataChanged()も参照してください 。
[signal]
void QPlaceManagerEngine::placeRemoved(const QString &placeId)
このシグナルは、場所がマネージャエンジンのデータストアから削除された場合に発行されます。削除された特定の場所はplaceId で指定されます。
このシグナルは、QPlaceManager::NotificationsFeature をサポートするマネージャエンジンのみが発行します。
dataChanged()も参照してください 。
[signal]
void QPlaceManagerEngine::placeUpdated(const QString &placeId)
このシグナルは、マネージャエンジンのデータストアで場所が変更された場合に発行されます。変更された特定の場所はplaceId で指定されます。
このシグナルは、QPlaceManager::NotificationsFeature をサポートするマネージャエンジンのみが発行します。
dataChanged()も参照してください 。
[virtual]
QPlaceIdReply *QPlaceManagerEngine::removeCategory(const QString &categoryId)
categoryId に対応するカテゴリをマネージャエンジンのデータストアから削除します。
[virtual]
QPlaceIdReply *QPlaceManagerEngine::removePlace(const QString &placeId)
placeId に対応する場所をマネージャ エンジンのデータストアから削除します。
[virtual]
QPlaceIdReply *QPlaceManagerEngine::saveCategory(const QPlaceCategory &category, const QString &parentId)
parentId で指定されたカテゴリの子であるcategory を保存します。空のparentId は、category がトップ レベル カ テ ゴ リ と し て保存 さ れ る こ と を意味 し ます。
[virtual]
QPlaceIdReply *QPlaceManagerEngine::savePlace(const QPlace &place)
指定 し たplace を、 マネージャー ・ エ ン ジ ンのデー タ ス ト アに保存 し ます。
[virtual]
QPlaceSearchReply *QPlaceManagerEngine::search(const QPlaceSearchRequest &request)
request で指定 さ れたパ ラ メ ー タ に従っ て場所を検索 し ます。
[virtual]
QPlaceSearchSuggestionReply *QPlaceManagerEngine::searchSuggestions(const QPlaceSearchRequest &request)
request で指定 さ れたパ ラ メ ー タ に従っ て、 検索語候補セ ッ ト を要求 し ます。
[virtual]
void QPlaceManagerEngine::setLocales(const QList<QLocale> &locales)
優先リストlocales を設定します。
locales()も参照してください 。
本書に含まれる文書の著作権は、各所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。