Класс QPlaceManagerEngine

Класс QPlaceManagerEngine предоставляет интерфейс для разработчиков плагинов QGeoServiceProvider, желающих предоставить доступ к функциональности мест. Подробнее...

Этот класс был добавлен в Qt 5.6.

• Список всех членов, включая унаследованные

Открытые функции

Сигналы

Защищённые функции

Подробное описание

Разработчикам приложений не нужно беспокоиться о QPlaceManagerEngine. Однако разработчикам бэкенда потребуется наследовать от QPlaceManagerEngine и предоставить реализации для абстрактных виртуальных функций.

Дополнительную информацию о написании бэкенда см. в документации по бэкенду мест.

См. также QPlaceManager.

Документация по функциям-членам

QPlaceManagerEngine::QPlaceManagerEngine(const QVariantMap &parameters, QObject *parent = nullptr)

Создаёт новый движок с указанным parent, используя parameters для передачи любых данных, специфичных для реализации, в движок.

[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().

[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() вместо этого.

[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] QPlaceManagerEngine::~QPlaceManagerEngine()

Уничтожает этот движок.

[virtual] QPlaceCategory QPlaceManagerEngine::category(const QString &categoryId) const

Возвращает категорию, соответствующую заданному categoryId.

[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 изображения иконки, наиболее точно соответствующего заданным параметрам.

[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.

[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)

Сохраняет указанное место в хранилище движка менеджера.

[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().