qplacemanagerengine.h

Go to the documentation of this file.

// Copyright (C) 2015 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#ifndef QPLACEMANAGERENGINE_H
#define QPLACEMANAGERENGINE_H
 
#include <QtLocation/QPlaceManager>
 
QT_BEGIN_NAMESPACE
 
class QPlaceManagerEnginePrivate;
class QPlaceMatchReply;
class QPlaceMatchRequest;
class QPlaceSearchReply;
class QPlaceSearchRequest;
class QPlaceSearchSuggestionReply;
 
class Q_LOCATION_EXPORT QPlaceManagerEngine : public QObject
{
    Q_OBJECT
 
public:
    explicit QPlaceManagerEngine(const QVariantMap &parameters, QObject *parent = nullptr);
    virtual ~QPlaceManagerEngine();
 
    QString managerName() const;
    int managerVersion() const;
 
    virtual QPlaceDetailsReply *getPlaceDetails(const QString &placeId);
 
    virtual QPlaceContentReply *getPlaceContent(const QPlaceContentRequest &request);
 
    virtual QPlaceSearchReply *search(const QPlaceSearchRequest &request);
 
    virtual QPlaceSearchSuggestionReply *searchSuggestions(const QPlaceSearchRequest &request);
 
    virtual QPlaceIdReply *savePlace(const QPlace &place);
    virtual QPlaceIdReply *removePlace(const QString &placeId);
 
    virtual QPlaceIdReply *saveCategory(const QPlaceCategory &category, const QString &parentId);
    virtual QPlaceIdReply *removeCategory(const QString &categoryId);
 
    virtual QPlaceReply *initializeCategories();
    virtual QString parentCategoryId(const QString &categoryId) const;
    virtual QStringList childCategoryIds(const QString &categoryId) const;
    virtual QPlaceCategory category(const QString &categoryId) const;
 
    virtual QList<QPlaceCategory> childCategories(const QString &parentId) const;
 
    virtual QList<QLocale> locales() const;
    virtual void setLocales(const QList<QLocale> &locales);
 
    virtual QUrl constructIconUrl(const QPlaceIcon &icon, const QSize &size) const;
 
    virtual QPlace compatiblePlace(const QPlace &original) const;
 
    virtual QPlaceMatchReply *matchingPlaces(const QPlaceMatchRequest &request);
 
Q_SIGNALS:
    void finished(QPlaceReply *reply);
    void errorOccurred(QPlaceReply *, QPlaceReply::Error error,
                       const QString &errorString = QString());
 
    void placeAdded(const QString &placeId);
    void placeUpdated(const QString &placeId);
    void placeRemoved(const QString &placeId);
 
    void categoryAdded(const QPlaceCategory &category, const QString &parentCategoryId);
    void categoryUpdated(const QPlaceCategory &category, const QString &parentCategoryId);
    void categoryRemoved(const QString &categoryId, const QString &parentCategoryId);
    void dataChanged();
 
protected:
    QPlaceManager *manager() const;
 
private:
    void setManagerName(const QString &managerName);
    void setManagerVersion(int managerVersion);
 
    QPlaceManagerEnginePrivate *d_ptr;
    Q_DISABLE_COPY(QPlaceManagerEngine)
 
    friend class QGeoServiceProviderPrivate;
    friend class QPlaceManager;
};
 
QT_END_NAMESPACE
 
#endif