1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtLocation module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL3$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPLv3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or later as published by the Free
28** Software Foundation and appearing in the file LICENSE.GPL included in
29** the packaging of this file. Please review the following information to
30** ensure the GNU General Public License version 2.0 requirements will be
31** met: http://www.gnu.org/licenses/gpl-2.0.html.
32**
33** $QT_END_LICENSE$
34**
35****************************************************************************/
36
37#ifndef QPLACESEARCHREQUEST_H
38#define QPLACESEARCHREQUEST_H
39
40#include <QtCore/QSharedDataPointer>
41#include <QtLocation/placemacro.h>
42#include <QtLocation/QPlaceCategory>
43#include <QtLocation/QLocation>
44
45QT_BEGIN_NAMESPACE
46
47class QGeoShape;
48class QPlaceSearchRequestPrivate;
49
50class Q_LOCATION_EXPORT QPlaceSearchRequest
51{
52public:
53 enum RelevanceHint {
54 UnspecifiedHint,
55 DistanceHint,
56 LexicalPlaceNameHint
57 };
58
59 QPlaceSearchRequest();
60 QPlaceSearchRequest(const QPlaceSearchRequest &other);
61
62
63 QPlaceSearchRequest &operator=(const QPlaceSearchRequest &other);
64
65 bool operator==(const QPlaceSearchRequest &other) const;
66 bool operator!=(const QPlaceSearchRequest &other) const;
67
68 ~QPlaceSearchRequest();
69
70 QString searchTerm() const;
71 void setSearchTerm(const QString &term);
72
73 QList<QPlaceCategory> categories() const;
74 void setCategory(const QPlaceCategory &category);
75 void setCategories(const QList<QPlaceCategory> &categories);
76
77 QGeoShape searchArea() const;
78 void setSearchArea(const QGeoShape &area);
79
80 QString recommendationId() const;
81 void setRecommendationId(const QString &recommendationId);
82
83 QVariant searchContext() const;
84 void setSearchContext(const QVariant &context);
85
86 QLocation::VisibilityScope visibilityScope() const;
87 void setVisibilityScope(QLocation::VisibilityScope visibilityScopes);
88
89 RelevanceHint relevanceHint() const;
90 void setRelevanceHint(RelevanceHint hint);
91
92 int limit() const;
93 void setLimit(int limit);
94
95 void clear();
96
97private:
98 QSharedDataPointer<QPlaceSearchRequestPrivate> d_ptr;
99 inline QPlaceSearchRequestPrivate *d_func();
100 inline const QPlaceSearchRequestPrivate *d_func() const;
101
102 friend class QPlaceSearchRequestPrivate;
103};
104
105QT_END_NAMESPACE
106
107Q_DECLARE_METATYPE(QPlaceSearchRequest::RelevanceHint)
108
109#endif // QPLACESEARCHQUERY_H
110

source code of qtlocation/src/location/places/qplacesearchrequest.h