Класс QPlaceManagerEngine

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

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

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

• 31 открытая функция, унаследованная от QObject

Сигналы

• 2 сигнала, унаследованных от QObject

Статические открытые члены

• 9 статических открытых членов, унаследованных от QObject

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

• 9 защищенных функций, унаследованных от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 открытый слот, унаследованный от QObject

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

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

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

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

См. также QPlaceManager.

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

QPlaceManagerEngine::QPlaceManagerEngine(const QVariantMap &parameters, QObject *parent = 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)

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

Этот сигнал излучается, если категория была изменена в хранилище данных движка менеджера. Родитель изменённой категории задаётся параметром 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 = ...)

Этот сигнал излучается, когда обнаружена ошибка в обработке 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().