summaryrefslogtreecommitdiffstats
path: root/src/networksettings/qnetworksettingsuseragent.cpp
blob: 59942bfd7cb3fbe6d907d7a0a3c82b350217233e (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
/****************************************************************************
**
** Copyright (C) 2019 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 "qnetworksettingsuseragent.h"
#include "qnetworksettingsuseragent_p.h"

QT_BEGIN_NAMESPACE

/*!
    \class QNetworkSettingsUserAgent
    \inmodule QtNetworkSettings

    \brief The QNetworkSettingsUserAgent represents the user credentials for
    connecting to a network.

    The QNetworkSettingsService::connectService() method is used to connect to
    a Wifi network. The network name is specified by using a service set
    identifier (SSID). If no password is needed, the connection is created
    immediately. QNetworkSettingsService::state property can be used to
    monitor the state of the connection.

    If a password is needed, the
    QNetworkSettingsUserAgent::showUserCredentialsInput() signal is emitted.
    To create a connection, the password is set by using the
    QNetworkSettingsUserAgent::setPassphrase() method.

    \sa QNetworkSettingsManager
*/

/*!
    \fn QNetworkSettingsUserAgent::showUserCredentialsInput()

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

    \sa QNetworkSettingsService::connectService()
*/

/*!
    \fn QNetworkSettingsUserAgent::error()

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

/*!
    \fn QNetworkSettingsUserAgent::ready(bool cancel)

    This signal is emitted when the user has either submitted the password
    for the network, or if \a cancel is \c true, cancelled the password
    query.
*/

/*!
    \fn QNetworkSettingsUserAgent::requestNextConnection()

    This signal is emitted when the network manager attempts to connect using
    the next network interface in the model.
*/

/*!
    Creates a user agent with the parent \a parent.
*/
QNetworkSettingsUserAgent::QNetworkSettingsUserAgent(QObject *parent)
    :QObject(parent)
    ,d_ptr(new QNetworkSettingsUserAgentPrivate(this))
{
}

/*!
    Sets the password for connecting to a Wifi network to \a passphrase.

    This method needs to be called in response to receiving the
    \l showUserCredentialsInput() signal.
*/
void QNetworkSettingsUserAgent::setPassphrase(const QString &passphrase)
{
    Q_D(QNetworkSettingsUserAgent);
    d->setPassphrase(passphrase);
}

/*!
    Cancels the user credentials input request.
*/
void QNetworkSettingsUserAgent::cancelInput()
{
    Q_D(QNetworkSettingsUserAgent);
    d->cancel();
}

/*!
    Returns the password of the user agent.
*/
QString QNetworkSettingsUserAgent::passphrase() const
{
    Q_D(const QNetworkSettingsUserAgent);
    return d->passphrase();
}

/*!
    Sets the name of the network to \a ssid and the password of the user agent
    to \a passphrase.
*/
void QNetworkSettingsUserAgent::setSsidAndPassphrase(const QString &ssid, const QString &passphrase)
{
    Q_D(QNetworkSettingsUserAgent);
    d->setSsidAndPassphrase(ssid, passphrase);
}

/*!
    Clears the connection state.
*/
void QNetworkSettingsUserAgent::clearConnectionState()
{
    Q_D(QNetworkSettingsUserAgent);
    d->clearConnectionState();
}

QT_END_NAMESPACE