/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QGEOSEARCHREPLY_H
#define QGEOSEARCHREPLY_H

#include "qgeoplace.h"

#include <QObject>
#include <QList>

QTM_BEGIN_NAMESPACE

class QGeoSearchReplyPrivate;

class Q_LOCATION_EXPORT QGeoSearchReply : public QObject
{
    Q_OBJECT

public:
    enum Error {
        NoError,
        EngineNotSetError,
        CommunicationError,
        ParseError,
        UnsupportedOptionError,
        CombinationError,
        UnknownError
    };

    QGeoSearchReply(Error error, const QString &errorString, QObject *parent = 0);
    virtual ~QGeoSearchReply();

    bool isFinished() const;
    Error error() const;
    QString errorString() const;

    QGeoBoundingArea* viewport() const;
    QList<QGeoPlace> places() const;

    int limit() const;
    int offset() const;

    virtual void abort();

Q_SIGNALS:
    void finished();
    void error(QGeoSearchReply::Error error, const QString &errorString = QString());

protected:
    QGeoSearchReply(QObject* parent = 0);

    void setError(Error error, const QString &errorString);
    void setFinished(bool finished);

    void setViewport(QGeoBoundingArea *viewport);
    void addPlace(const QGeoPlace &place);
    void setPlaces(const QList<QGeoPlace> &places);

    void setLimit(int limit);
    void setOffset(int offset);

private:
    QGeoSearchReplyPrivate *d_ptr;
    Q_DISABLE_COPY(QGeoSearchReply)
};

QTM_END_NAMESPACE

#endif