Класс QPlaceManagerEngine
Класс QPlaceManagerEngine предоставляет интерфейс для разработчиков плагинов QGeoServiceProvider, желающих предоставить доступ к функциональности мест. Подробнее...
| Заголовок: | #include <QPlaceManagerEngine> |
| qmake: | QT += location |
| С тех пор: | Qt 5.6 |
| Наследует: | QObject |
Открытые функции
| QPlaceManagerEngine(const QVariantMap ¶meters, QObject *parent = Q_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) |
- 32 открытых функций, унаследованных от QObject
Сигналы
| 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 | error(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) |
- 2 сигнала, унаследованных от QObject
Защищённые функции
| QPlaceManager * | manager() const |
- 9 защищённых функций, унаследованных от QObject
Дополнительные унаследованные члены
- 1 свойство, унаследованное от QObject
- 1 открытый слот, унаследованный от QObject
- 11 статических открытых членов, унаследованных от QObject
Подробное описание
Класс QPlaceManagerEngine предоставляет интерфейс для разработчиков плагинов QGeoServiceProvider, желающих предоставить доступ к функциональности мест.
Разработчикам приложений не нужно беспокоиться о классе QPlaceManagerEngine. Однако разработчикам бэкендов нужно будет унаследовать от QPlaceManagerEngine и предоставить реализации абстрактных виртуальных функций.
Дополнительную информацию по написанию бэкенда см. в документации Бэкенда мест.
См. также QPlaceManager.
Документация по функциям-членам
QPlaceManagerEngine::QPlaceManagerEngine(const QVariantMap ¶meters, QObject *parent = Q_NULLPTR)
Создаёт новый движок со заданным parent, используя parameters для передачи данных, специфичных для реализации, в движок.
[virtual] 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, подходящую для сохранения движком менеджера.
В изменённой версии присутствуют только те детали места, которые поддерживаются этим менеджером. Данные, специфичные для менеджера, такие как идентификатор места, не копируются из original.
[virtual] QUrl QPlaceManagerEngine::constructIconUrl(const QPlaceIcon &icon, const QSize &size) const
QUrl QPlaceManagerEngine::constructIconUrl(const QPlaceIcon &icon, const QSize &size)
Создаёт URL иконки из заданной иконки icon и размера size. Возвращается URL изображения иконки, наиболее точно соответствующего заданным параметрам.
[signal] void QPlaceManagerEngine::dataChanged()
*
Этот сигнал испускается движком, если произошли масштабные изменения в его базовом хранилище данных, и движок считает эти изменения радикальными, требующими от клиентов перезагрузки всех данных.
Если сигнал испущен, для связанных изменений другие сигналы не будут испускаться.
[signal] void QPlaceManagerEngine::error(QPlaceReply *reply, QPlaceReply::Error error, const QString &errorString = QString())
Этот сигнал испускается при обнаружении ошибки в обработке reply. Вероятно, последует сигнал QPlaceManager::finished().
Ошибка будет описана кодом ошибки error. Если errorString не пуста, она будет содержать текстовое описание ошибки для разработчиков, а не конечных пользователей.
Этот сигнал и QPlaceReply::error() будут испущены одновременно.
Примечание: Не удаляйте объект 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
Возвращает список предпочтительных языковых наборов. Языковые наборы используются в качестве подсказки для движка менеджера, в каком языке должны быть возвращены сведения о месте и категории.
Если первый указанный языковой набор не поддерживается, движок менеджера переходит к следующему и так далее.
Поддержка языковых наборов может различаться в зависимости от поставщика. Для тех, кто поддерживает, по умолчанию используется глобальный языковой набор по умолчанию. Если языковые наборы не назначены движку менеджера, он неявно использует глобальный языковой набор по умолчанию. Для движков, не поддерживающих языковые наборы, список языковых наборов всегда пустой.
См. также 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)
Сохраняет category как дочерний элемент категории, указанной parentId. Пустой 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().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qplacemanagerengine.html