Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qdeclarativecategory_p.h
Go to the documentation of this file.
1// Copyright (C) 2022 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QDECLARATIVECATEGORY_P_H
6#define QDECLARATIVECATEGORY_P_H
7
8//
9// W A R N I N G
10// -------------
11//
12// This file is not part of the Qt API. It exists purely as an
13// implementation detail. This header file may change from version to
14// version without notice, or even be removed.
15//
16// We mean it.
17//
18
19#include <QtLocation/private/qlocationglobal_p.h>
20#include <QtQml/qqml.h>
21#include <QtQml/QQmlParserStatus>
22#include <QObject>
23
24#include <QtLocation/qplacecategory.h>
25#include <QtLocation/qplaceicon.h>
26
27#include <QtLocation/private/qdeclarativegeoserviceprovider_p.h>
28
29QT_BEGIN_NAMESPACE
30
31class QPlaceReply;
32class QPlaceManager;
33
34class Q_LOCATION_EXPORT QDeclarativeCategory : public QObject, public QQmlParserStatus
35{
36 Q_OBJECT
37 QML_NAMED_ELEMENT(Category)
38 QML_ADDED_IN_VERSION(5, 0)
39
40 Q_PROPERTY(QPlaceCategory category READ category WRITE setCategory)
41 Q_PROPERTY(QDeclarativeGeoServiceProvider *plugin READ plugin WRITE setPlugin NOTIFY pluginChanged)
42 Q_PROPERTY(QString categoryId READ categoryId WRITE setCategoryId NOTIFY categoryIdChanged)
43 Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
44 Q_PROPERTY(Visibility visibility READ visibility WRITE setVisibility NOTIFY visibilityChanged)
45 Q_PROPERTY(QPlaceIcon icon READ icon WRITE setIcon NOTIFY iconChanged)
46 Q_PROPERTY(Status status READ status NOTIFY statusChanged)
47
48 Q_INTERFACES(QQmlParserStatus)
49
50public:
51 explicit QDeclarativeCategory(QObject *parent = nullptr);
52 QDeclarativeCategory(const QPlaceCategory &category, QDeclarativeGeoServiceProvider *plugin, QObject *parent = nullptr);
53 ~QDeclarativeCategory();
54
55 enum Visibility {
56 UnspecifiedVisibility = QLocation::UnspecifiedVisibility,
57 DeviceVisibility = QLocation::DeviceVisibility,
58 PrivateVisibility = QLocation::PrivateVisibility,
59 PublicVisibility = QLocation::PublicVisibility
60 };
61 Q_ENUM(Visibility)
62
63 enum Status {Ready, Saving, Removing, Error};
64 Q_ENUM(Status)
65
66 //From QQmlParserStatus
67 void classBegin() override {}
68 void componentComplete() override;
69
70 void setPlugin(QDeclarativeGeoServiceProvider *plugin);
71 QDeclarativeGeoServiceProvider *plugin() const;
72
73 QPlaceCategory category();
74 void setCategory(const QPlaceCategory &category);
75
76 QString categoryId() const;
77 void setCategoryId(const QString &catID);
78 QString name() const;
79 void setName(const QString &name);
80
81 Visibility visibility() const;
82 void setVisibility(Visibility visibility);
83
84 QPlaceIcon icon() const;
85 void setIcon(const QPlaceIcon &icon);
86
87 Q_INVOKABLE QString errorString() const;
88
89 Status status() const;
90 void setStatus(Status status, const QString &errorString = QString());
91
92 Q_INVOKABLE void save(const QString &parentId = QString());
93 Q_INVOKABLE void remove();
94
95Q_SIGNALS:
96 void pluginChanged();
97 void categoryIdChanged();
98 void nameChanged();
99 void visibilityChanged();
100 void iconChanged();
101 void statusChanged();
102
103private Q_SLOTS:
104 void replyFinished();
105 void pluginReady();
106
107private:
108 QPlaceManager *manager();
109
110 QPlaceCategory m_category;
111 QDeclarativeGeoServiceProvider *m_plugin = nullptr;
112 QPlaceReply *m_reply = nullptr;
113 bool m_complete = false;
114 Status m_status = Ready;
115 QString m_errorString;
116};
117
118QT_END_NAMESPACE
119
120QML_DECLARE_TYPE(QDeclarativeCategory)
121
122#endif // QDECLARATIVECATEGORY_P_H
Combined button and popup list for selecting options.