/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QGEOSEARCHMANAGER_H
#define QGEOSEARCHMANAGER_H

#include "qgeosearchreply.h"
#include "qgeoboundingbox.h"

#include <QObject>
#include <QList>
#include <QMap>

class QLocale;

QTM_BEGIN_NAMESPACE

class QLandmarkManager;

class QGeoSearchManagerEngine;
class QGeoSearchManagerPrivate;

class Q_LOCATION_EXPORT QGeoSearchManager : public QObject
{
    Q_OBJECT
public:
    enum SearchType {
        SearchNone = 0x0000,
        SearchGeocode = 0x0001,
        SearchLandmarks = 0x0002,
        SearchAll = 0xFFFF
    };
    Q_DECLARE_FLAGS(SearchTypes, SearchType)

    ~QGeoSearchManager();

    QString managerName() const;
    int managerVersion() const;

    QGeoSearchReply* geocode(const QGeoAddress &address,
                             QGeoBoundingArea *bounds = 0);
    QGeoSearchReply* reverseGeocode(const QGeoCoordinate &coordinate,
                                    QGeoBoundingArea *bounds = 0);

    QGeoSearchReply* search(const QString &searchString,
                            SearchTypes searchTypes = SearchTypes(SearchAll),
                            int limit = -1,
                            int offset = 0,
                            QGeoBoundingArea *bounds = 0);

    bool supportsGeocoding() const;
    bool supportsReverseGeocoding() const;
    SearchTypes supportedSearchTypes() const;

    QLandmarkManager* defaultLandmarkManager() const;

    void setAdditionalLandmarkManagers(const QList<QLandmarkManager *> &landmarkManagers);
    QList<QLandmarkManager *> additionalLandmarkManagers() const;
    void addAdditionalLandmarkManager(QLandmarkManager *landmarkManager);

    void setLocale(const QLocale &locale);
    QLocale locale() const;

Q_SIGNALS:
    void finished(QGeoSearchReply* reply);
    void error(QGeoSearchReply* reply, QGeoSearchReply::Error error, QString errorString = QString());

private:
    QGeoSearchManager(QGeoSearchManagerEngine *engine, QObject *parent = 0);

    QGeoSearchManagerPrivate *d_ptr;
    Q_DISABLE_COPY(QGeoSearchManager)

    friend class QGeoServiceProvider;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QGeoSearchManager::SearchTypes)

QTM_END_NAMESPACE

#endif
