Класс QPlaceManagerEngine

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

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

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

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

Сигналы

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

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

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

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

• 1 свойство, унаследованное от QObject
• 1 открытый слот, унаследованный от QObject
• 1 открытая переменная, унаследованная от QObject
• 10 статических открытых членов, унаследованных от QObject
• 2 защищенные переменные, унаследованные от 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)

Этот сигнал излучается, если 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 = ...)

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