Класс QPlaceManager

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

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

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

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

Сигналы

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

В следующей таблице представлен обзор функциональных возможностей класса QPlaceManager.

Получение экземпляра QPlaceManager

Создание QPlaceManager осуществляется с помощью QGeoServiceProvider. См. Инициализация менеджера для примера создания менеджера.

Асинхронный интерфейс

Класс QPlaceManager предоставляет абстракцию хранилища данных, содержащего информацию о местах. Функции, предоставляемые QPlaceManager, в основном асинхронны и следуют модели «запрос-ответ». Обычно менеджеру предоставляется запрос, состоящий из различных параметров, и создается объект ответа. Объект ответа имеет сигнал для уведомления о завершении запроса, а после завершения он содержит результаты запроса и любые возникшие ошибки, если таковые имеются.

Асинхронный запрос обычно обрабатывается следующим образом:

//1) Make an appropriate request
QPlaceSearchRequest searchRequest;
searchRequest.setSearchTerm("ice cream");
searchRequest.setSearchArea(QGeoCircle(QGeoCoordinate(12.34, 56.78)));

//2) Use the manager to initiate a request and retrieve a reply object
QPlaceSearchReply * searchReply = manager->search(searchRequest);

//3) Connect the reply object to a slot which is invoked upon operation completion
connect(searchReply, SIGNAL(finished()), this, SLOT(processSearchReply()));
    ...
    ...
//4) Have the slot appropriately process the results of the operation
void processSearchReply() {
    if (searchReply->error() == QPlaceReply::NoError) {
        foreach (const QPlaceSearchResult &result, searchReply->results()) {
            if (result.type() == QPlaceSearchResult::PlaceResult)
                qDebug() << "Title:" << result.title();
        }
    }

//5) Discard the rely object when done.
    searchReply->deleteLater();
    searchReply = 0;
}

См. Общие операции для списка примеров, демонстрирующих использование QPlaceManger.

Инициализация категорий

Иногда во время запуска приложения следует вызвать функцию initializeCategories() для настройки категорий. Инициализация категорий позволяет использовать следующие функции:

• QPlaceManager::childCategories()
• QPlaceManager::category()
• QPlaceManager::parentCategoryId()
• QPlaceManager::childCategoryIds();

Если категории необходимо обновить или перезагрузить, функцию initializeCategories() можно вызвать еще раз.

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

[signal] void QPlaceManager::categoryAdded(const QPlaceCategory &category, const QString &parentId)

Этот сигнал излучается, если category была добавлена в хранилище данных менеджера. Родитель category указан параметром parentId.

Этот сигнал излучается только менеджерами, поддерживающими QPlaceManager::NotificationsFeature.

См. также dataChanged().

[signal] void QPlaceManager::categoryRemoved(const QString &categoryId, const QString &parentId)

Этот сигнал испускается, когда категория, соответствующая categoryId, была удалена из хранилища данных менеджера. Родитель удалённой категории указан параметром parentId.

Этот сигнал испускается только менеджерами, поддерживающими QPlaceManager::NotificationsFeature.

См. также dataChanged().

[signal] void QPlaceManager::categoryUpdated(const QPlaceCategory &category, const QString &parentId)

Этот сигнал испускается, если категория category была изменена в хранилище данных менеджера. Родитель изменённой категории указан параметром parentId.

Этот сигнал испускается только менеджерами, поддерживающими QPlaceManager::NotificationsFeature.

См. также dataChanged().

[signal] void QPlaceManager::dataChanged()

Этот сигнал испускается менеджером, если произошли масштабные изменения в его базовом хранилище данных, и менеджер считает эти изменения достаточно радикальными, чтобы потребовать от клиентов перезагрузку всех данных.

Если сигнал испущен, другие сигналы для связанных изменений не будут испускаться.

Этот сигнал испускается только менеджерами, поддерживающими QPlaceManager::NotificationsFeature.

[signal] void QPlaceManager::error(QPlaceReply *reply, QPlaceReply::Error error, const QString &errorString = QString())

Этот сигнал испускается, когда в обработке reply была обнаружена ошибка. Вероятно, последует сигнал QPlaceManager::finished().

Ошибка будет описана кодом ошибки error. Если errorString не пуста, она будет содержать текстовое описание ошибки, предназначенное для разработчиков, а не конечных пользователей.

Этот сигнал и QPlaceReply::error() будут испускаться одновременно.

Примечание: Не удаляйте объект reply в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.

[signal] void QPlaceManager::finished(QPlaceReply *reply)

Этот сигнал испускается, когда обработка reply завершена.

Если reply->error() равно QPlaceReply::NoError, обработка завершилась успешно.

Этот сигнал и QPlaceReply::finished() будут испускаться одновременно.

Примечание: Не удаляйте объект reply в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.

[signal] void QPlaceManager::placeAdded(const QString &placeId)

Этот сигнал испускается, если место было добавлено в хранилище данных движка менеджера. Конкретное добавленное место указано параметром placeId.

Этот сигнал испускается только менеджерами, поддерживающими QPlaceManager::NotificationsFeature.

См. также dataChanged().

[signal] void QPlaceManager::placeRemoved(const QString &placeId)

Этот сигнал испускается, если место было удалено из хранилища данных менеджера. Конкретное удалённое место указано параметром placeId.

Этот сигнал испускается только менеджерами, поддерживающими QPlaceManager::NotificationsFeature.

См. также dataChanged().

[signal] void QPlaceManager::placeUpdated(const QString &placeId)

Этот сигнал испускается, если место было изменено в хранилище данных менеджера. Конкретное изменённое место указано параметром placeId.

Этот сигнал испускается только менеджерами, поддерживающими QPlaceManager::NotificationsFeature.

См. также dataChanged().

[virtual] QPlaceManager::~QPlaceManager()

Удаляет менеджер. Этот деструктор используется внутри QGeoServiceProvider и никогда не должен вызываться в коде приложения.

QPlaceCategory QPlaceManager::category(const QString &categoryId) const

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

QList<QPlaceCategory> QPlaceManager::childCategories(const QString &parentId = QString()) const

Возвращает список категорий, являющихся дочерними по отношению к категории, соответствующей parentId. Если parentId пустая, возвращаются все категории верхнего уровня.

QStringList QPlaceManager::childCategoryIds(const QString &parentId = QString()) const

Возвращает идентификаторы дочерних категорий категории, соответствующей parentId. Если parentId пустая, возвращаются идентификаторы всех категорий верхнего уровня.

QPlace QPlaceManager::compatiblePlace(const QPlace &original)

Возвращает обрезанную или изменённую версию места original, подходящую для сохранения в этом менеджере.

В изменённой версии присутствуют только те детали места, которые поддерживаются этим менеджером. Управляемая менеджером информация, такая как идентификатор места, не копируется из original.

QPlaceContentReply *QPlaceManager::getPlaceContent(const QPlaceContentRequest &request) const

Извлекает содержимое места в соответствии с параметрами, указанными в request.

См. Извлечение богатого содержимого для примера использования.

QPlaceDetailsReply *QPlaceManager::getPlaceDetails(const QString &placeId) const

Извлекает детали места, соответствующего заданному placeId.

См. Извлечение деталей места для примера использования.

QPlaceReply *QPlaceManager::initializeCategories()

Инициализирует категории менеджера.

См. Использование категорий для примера использования.

QList<QLocale> QPlaceManager::locales() const

Возвращает список предпочтительных языковых локалей. Локали используются в качестве подсказки для менеджера, на каком языке должны возвращаться детали мест и категорий.

Если первая указанная локаль недоступна, менеджер переходит к следующей и так далее. Некоторые бэкэнды менеджеров могут не поддерживать строго определённый набор локалей. Примером является то, что некоторые места во Франции могут иметь французскую и английскую локализации, а в определённых районах Америки может быть доступна только английская локализация. В этом примере набор поддерживаемых локалей зависит от контекста местоположения.

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

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

Для менеджеров, которые не поддерживают локали, список локалей всегда пустой.

См. также setLocales().

QString QPlaceManager::managerName() const

Возвращает имя менеджера

int QPlaceManager::managerVersion() const

Возвращает версию менеджера.

QPlaceMatchReply *QPlaceManager::matchingPlaces(const QPlaceMatchRequest &request) const

Возвращает ответ, содержащий список мест, соответствующих/сопоставляемых тем, которые указаны в request. Указанные в запросе места происходят из другого менеджера.

QString QPlaceManager::parentCategoryId(const QString &categoryId) const

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

QPlaceIdReply *QPlaceManager::removeCategory(const QString &categoryId)

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

См. Удаление категории для примера использования.

QPlaceIdReply *QPlaceManager::removePlace(const QString &placeId)

Удаляет место, соответствующее placeId, из менеджера.

См. Удаление места cpp для примера использования.

QPlaceIdReply *QPlaceManager::saveCategory(const QPlaceCategory &category, const QString &parentId = QString())

Сохраняет category, являющуюся дочерней категорией, указанной parentId. Пустая parentId означает, что category сохраняется как категория верхнего уровня.

См. Сохранение категории для примера использования.

QPlaceIdReply *QPlaceManager::savePlace(const QPlace &place)

Сохраняет указанное место.

См. Сохранение места cpp для примера использования.

QPlaceSearchReply *QPlaceManager::search(const QPlaceSearchRequest &request) const

Ищет места в соответствии с параметрами, указанными в request.

См. Обнаружение/Поиск для примера использования.

QPlaceSearchSuggestionReply *QPlaceManager::searchSuggestions(const QPlaceSearchRequest &request) const

Запрашивает набор предложений по поисковым терминам в соответствии с параметрами, указанными в request. request может содержать неполный поисковый термин, а также другие данные, такие как область поиска для сужения релевантных результатов.

См. Предложения по поиску для примера использования.

void QPlaceManager::setLocale(const QLocale &locale)

Функция-утилита, которая устанавливает список предпочтительных языковых локалей менеджера на одну locale.

void QPlaceManager::setLocales(const QList<QLocale> &locales)

Устанавливает список предпочтительных locales.

См. также locales().