summaryrefslogtreecommitdiff
path: root/src/location/places/qplacesearchresult.cpp
blob: 8cf8a4e0cae49375b2f07ad0c16e0425feb4e719 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $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$
**
****************************************************************************/

#include "qplacesearchresult.h"
#include "qplacesearchresult_p.h"
#include <QtCore/qnumeric.h>

QT_USE_NAMESPACE

QPlaceSearchResultPrivate::QPlaceSearchResultPrivate()
    :   QSharedData(), distance(qQNaN()), type(QPlaceSearchResult::UnknownSearchResult)
{
}

QPlaceSearchResultPrivate::QPlaceSearchResultPrivate(const QPlaceSearchResultPrivate &other)
    : QSharedData()
{
    distance = other.distance;
    type = other.type;
    place = other.place;
    correction = other.correction;
}

QPlaceSearchResultPrivate::~QPlaceSearchResultPrivate()
{
}

bool QPlaceSearchResultPrivate::operator==(const QPlaceSearchResultPrivate &other) const
{
    return distance == other.distance &&
           type == other.type &&
           place == other.place &&
           correction == other.correction;
}

/*!
    \class QPlaceSearchResult
    \inmodule QtLocation
    \ingroup QtLocation-places
    \ingroup QtLocation-places-data
    \since QtLocation 5.0

    \brief The QPlaceSearchResult class represents a search result.

    There are two types of search result.  The first is a
    \l {QPlaceSearchResult::PlaceResult} {place result}, which contains
    a place that matched a search request, but also metadata about the place
    such as the distance from the search center of a search request(if it had one).

    The other type is a \l {QPlaceSearchResult::CorrectionResult}{correction}, which
    contains an alternative search term that may better reflect the
    user's intended query.

*/

/*!
    \enum QPlaceSearchResult::SearchResultType
    Defines the type of search result
    \value PlaceResult The search result contains a place.
    \value CorrectionResult The search result contains a search term correction.
    \value UnknownSearchResult The contents of the search result are unknown.
*/

/*!
    Constructs an new search result.
*/
QPlaceSearchResult::QPlaceSearchResult()
    : d(new QPlaceSearchResultPrivate)
{
}

/*!
    Constructs a copy of \a other
*/
QPlaceSearchResult::QPlaceSearchResult(const QPlaceSearchResult &other)
    :d(other.d)
{
}

/*!
    Destroys the search result.
*/
QPlaceSearchResult::~QPlaceSearchResult()
{
}

/*!
    Assigns \a other to this search result and returns a reference to this
    search result.
*/
QPlaceSearchResult &QPlaceSearchResult::operator =(const QPlaceSearchResult &other) {
    d = other.d;
    return *this;
}

/*!
    Returns true if \a other is equal to this search result, otherwise
    returns false.
*/
bool QPlaceSearchResult::operator==(const QPlaceSearchResult &other) const
{
    return (*(d.constData()) == *(other.d.constData()));
}

/*!
    \fn bool QPlaceSearchResult::operator!=(const QPlaceSearchResult &other) const
    Returns true if \a other not equal to this search result, otherwise
    returns false.
*/

/*!
    Returns the distance of the place to the search center.  This field
    is only valid when the search result type is QPlaceSearchResult::PlaceResult,
    and where the search request contained a search center.  Otherwise,
    the distance is NaN indicating an undefined distance.  The default value
    for distance is NaN.
*/
qreal QPlaceSearchResult::distance() const
{
    return d->distance;
}

/*!
    Set the \a distance of the search result's place from a search center.
*/
void QPlaceSearchResult::setDistance(qreal distance)
{
    d->distance = distance;
}

/*!
    Returns the type of the search result.
*/
QPlaceSearchResult::SearchResultType QPlaceSearchResult::type() const
{
    return d->type;
}

/*!
    Sets the \a type of the search result.
*/
void QPlaceSearchResult::setType(QPlaceSearchResult::SearchResultType type)
{
    d->type = type;
}

/*!
    Returns the place of the search result.  This field is only valid when the search result
    type is QPlaceSearchResult::PlaceResult.
*/
QPlace QPlaceSearchResult::place() const
{
    return d->place;
}

/*!
    Sets the \a place that this search result refers to.
*/
void QPlaceSearchResult::setPlace(const QPlace &place)
{
    d->place = place;
}

/*!
    Returns the correction term that this particular search result represents.
    This field is only valid when the search result type is QPlaceSearchResult::CorrectionResult.
*/
QString QPlaceSearchResult::correction() const
{
    return d->correction;
}

/*!
    Sets the \a correction term of the search result.
*/
void QPlaceSearchResult::setCorrection(const QString &correction)
{
    d->correction = correction;
}