1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtPositioning module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
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 https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39#ifndef QGEOAREAMONITORSOURCE_H
40#define QGEOAREAMONITORSOURCE_H
41
42#include <QtPositioning/QGeoCoordinate>
43#include <QtPositioning/QGeoAreaMonitorInfo>
44#include <QtPositioning/QGeoPositionInfoSource>
45
46#include <QtCore/QObject>
47#include <QtCore/QStringList>
48
49QT_BEGIN_NAMESPACE
50
51class QGeoPositionInfo;
52class QGeoAreaMonitorSourcePrivate;
53class Q_POSITIONING_EXPORT QGeoAreaMonitorSource : public QObject
54{
55 Q_OBJECT
56
57public:
58 enum Error {
59 AccessError = 0,
60 InsufficientPositionInfo = 1,
61 UnknownSourceError = 2,
62 NoError = 3
63 };
64 Q_ENUMS(Error)
65
66 enum AreaMonitorFeature {
67 PersistentAreaMonitorFeature = 0x00000001,
68 AnyAreaMonitorFeature = 0xffffffff
69 };
70 Q_DECLARE_FLAGS(AreaMonitorFeatures, AreaMonitorFeature)
71
72 explicit QGeoAreaMonitorSource(QObject *parent);
73 virtual ~QGeoAreaMonitorSource();
74
75 static QGeoAreaMonitorSource *createDefaultSource(QObject *parent);
76 static QGeoAreaMonitorSource *createSource(const QString& sourceName, QObject *parent);
77 static QStringList availableSources();
78
79 virtual void setPositionInfoSource(QGeoPositionInfoSource *source);
80 virtual QGeoPositionInfoSource* positionInfoSource() const;
81
82 QString sourceName() const;
83
84 virtual Error error() const = 0;
85 virtual AreaMonitorFeatures supportedAreaMonitorFeatures() const = 0;
86
87 virtual bool startMonitoring(const QGeoAreaMonitorInfo &monitor) = 0;
88 virtual bool stopMonitoring(const QGeoAreaMonitorInfo &monitor) = 0;
89 virtual bool requestUpdate(const QGeoAreaMonitorInfo &monitor, const char *signal) = 0;
90
91 virtual QList<QGeoAreaMonitorInfo> activeMonitors() const = 0;
92 virtual QList<QGeoAreaMonitorInfo> activeMonitors(const QGeoShape &lookupArea) const = 0;
93
94Q_SIGNALS:
95 void areaEntered(const QGeoAreaMonitorInfo &monitor, const QGeoPositionInfo &update);
96 void areaExited(const QGeoAreaMonitorInfo &monitor, const QGeoPositionInfo &update);
97 void monitorExpired(const QGeoAreaMonitorInfo &monitor);
98 void error(QGeoAreaMonitorSource::Error error);
99
100private:
101 Q_DISABLE_COPY(QGeoAreaMonitorSource)
102 QGeoAreaMonitorSourcePrivate *d;
103};
104
105
106QT_END_NAMESPACE
107
108#endif
109

source code of qtlocation/src/positioning/qgeoareamonitorsource.h