summaryrefslogtreecommitdiffstats
path: root/src/imports/networksettings/plugin.cpp
blob: 431a09911bb6e889fd8a66a69db31aec4ea8c13f (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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Device Utilities module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "plugin.h"
#include <qnetworksettings.h>
#include <qnetworksettingsmanager.h>
#include <qnetworksettingsservice.h>
#include <qnetworksettingsuseragent.h>
#include <qnetworksettingsservicemodel.h>
#include <qnetworksettingsinterface.h>
#include <qnetworksettingsinterfacemodel.h>

#include <qqml.h>
#include <QQmlEngine>
#include <QQmlContext>

/*!
    \qmlmodule QtDeviceUtilities.NetworkSettings 1.0

    \title Qt Device Utilities: Network Settings
    \ingroup qtee-qmlmodules
    \brief Provides singleton QML types for controlling network settings.

    Provides singleton QML types for controlling network settings in an
    embedded device.QAbstractItemModel

    Import the module as follows:

    \badcode
    import QtDeviceUtilities.NetworkSettings 1.0
    \endcode

    \l{Qt Device Utilities WiFi Tutorial} demonstrates how you can use
    \l{QtDeviceUtilities.NetworkSettings}{NetworkSettings} for connecting to WiFi.

    \note Some functions may not be available on all of the platforms.

    \section1 QML Types
*/

/*!
    \qmltype NetworkSettingsManager
    \inqmlmodule QtDeviceUtilities.NetworkSettings
    \brief A singleton QML type for managing network settings.

    There is no need to create an instance of this object. To use it,
    simply import the \c {QtDeviceUtilities.NetworkSettings} module.

    \l{Qt Device Utilities WiFi Tutorial} demonstrates how you can use
    \l{NetworkSettingsManager} for connecting to WiFi.
*/

/*!
    \qmlproperty model NetworkSettingsManager::services
    \readonly

    Holds the service model.

    The services list in the model can be controlled with the
    \c type property, and NetworkService items can be retrieved
    with the \c {itemFromRow(int index)} method. For example, to
    select the first available wired network service:

    \code
    property var service: null
    ...
    NetworkSettingsManager.services.type = NetworkSettingsType.Wired;
    service = NetworkSettingsManager.services.itemFromRow(0);
    \endcode

    Available service types:

    \value NetworkSettingsType.Wired     Wired network
    \value NetworkSettingsType.Wifi      Wifi network
    \value NetworkSettingsType.Bluetooth Bluetooth network
    \value NetworkSettingsType.Unknown   Unknown network type

    \sa NetworkService
*/

/*!
    \qmlproperty model NetworkSettingsManager::interfaces
    \readonly

    Holds the interface model. A delegate in a view that uses
    the \e interfaces model can access the NetworkInterface
    item with the \e dataModel role.

    \sa NetworkInterface
*/

/*!
    \qmlmethod NetworkService NetworkSettingsManager::service(string name, int type)

    Returns the service with name \a name and type \a type.

    \sa services
*/

/*!
    \qmlmethod NetworkInterface NetworkSettingsManager::interface(int type, int instance)

    Returns the interface with type \a type and order number of \a instance

    \sa NetworkInterface
*/

/*!
    \qmlmethod NetworkSettingsManager::userAgent.setPassphrase(string passphrase)

    Sets the \a passphrase for connecting to a Wifi network.

    This method needs to be called in response to receiving a showUserCredentialsInput() signal.

    \sa userAgent.showUserCredentialsInput()
*/

/*!
    \qmlsignal NetworkSettingsManager::userAgent.showUserCredentialsInput()

    This signal is emitted when user credentials are required for connecting to a Wifi network.

    \sa userAgent.setPassphrase()
*/

/*!
    \qmlmethod NetworkSettingsManager::userAgent.cancelInput()

    Cancels the user credentials input request.
*/

/*!
    \qmlsignal NetworkSettingsManager::userAgent.error()

    This signal is emitted when the connection failed due to invalid user credentials.
*/

template <typename T>
QObject *instance(QQmlEngine *engine, QJSEngine *) {
    T *t = new T(engine);
    t->setObjectName(T::staticMetaObject.className());
    return t;
}

void NetworksettingspluginPlugin::registerTypes(const char *uri)
{
    Q_ASSERT(QLatin1String(uri) == QLatin1String("QtDeviceUtilities.NetworkSettings"));
    qmlRegisterUncreatableType<QNetworkSettingsService>(uri, 1, 0, "NetworkService", "Cannot be instantiated directly.");
    qmlRegisterUncreatableType<QNetworkSettingsInterface>(uri, 1, 0, "NetworkInterface", "Cannot be instantiated directly.");
    qmlRegisterUncreatableType<QNetworkSettingsIPv4>(uri, 1, 0, "NetworkSettingsIPv4", "Cannot be instantiated directly.");
    qmlRegisterUncreatableType<QNetworkSettingsIPv6>(uri, 1, 0, "NetworkSettingsIPv6", "Cannot be instantiated directly.");
    qmlRegisterUncreatableType<QNetworkSettingsProxy>(uri, 1, 0, "NetworkSettingsProxy", "Cannot be instantiated directly.");
    qmlRegisterUncreatableType<QNetworkSettingsType>(uri, 1, 0, "NetworkSettingsType", "Cannot be instantiated directly.");
    qmlRegisterUncreatableType<QNetworkSettingsState>(uri, 1, 0, "NetworkSettingsState", "Cannot be instantiated directly.");

    qRegisterMetaType<QNetworkSettingsUserAgent*>("QNetworkSettingsUserAgent*");
    qRegisterMetaType<QNetworkSettingsServiceFilter*>("QNetworkSettingsServiceFilter*");
    qRegisterMetaType<QNetworkSettingsInterfaceModel*>("QNetworkSettingsInterfaceModel*");

    qmlRegisterSingletonType<QNetworkSettingsManager>(uri, 1, 0, "NetworkSettingsManager", &instance<QNetworkSettingsManager>);
}