summaryrefslogtreecommitdiffstats
path: root/src/wifi/qwificonfiguration.cpp
blob: 42196a2dae79018deb1a4d30c3443cf7269efcfc (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
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc
** All rights reserved.
** For any questions to Digia, please use the contact form at
** http://www.qt.io
**
** This file is part of Qt Enterprise Embedded.
**
** Licensees holding valid Qt Enterprise licenses may use this file in
** accordance with the Qt Enterprise License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.
**
** If you have questions regarding the use of this file, please use
** the contact form at http://www.qt.io
**
****************************************************************************/
#include "qwificonfiguration.h"

QT_BEGIN_NAMESPACE

class QWifiConfigurationPrivate
{
    Q_DECLARE_PUBLIC(QWifiConfiguration)
public:
    QWifiConfigurationPrivate(QWifiConfiguration *config);

    // member variables
    QWifiConfiguration *const q_ptr;
    QString m_ssid;
    QString m_psk;
    QString m_protocol;
};

QWifiConfigurationPrivate::QWifiConfigurationPrivate(QWifiConfiguration *config)
    : q_ptr(config)
{
}

/*!
    \class QWifiConfiguration
    \inmodule B2Qt.Wifi.Cpp
    \ingroup wifi-cppclasses
    \brief Used to define a network configuration.

    QWifiConfiguration object represents a single network configuration. Use it
    to configure properties of your network. For example, passphrase, security
    protocol to use, and so on. QWifiManager::connect() function uses this
    information to find a network that matches the provided configuration, before
    establishing a connection.
 */

/*!
    Constructs a configuration object with parent \a parent.
*/
QWifiConfiguration::QWifiConfiguration(QObject *parent)
    : QObject(parent)
    , d_ptr(new QWifiConfigurationPrivate(this))
{
}

/*!
    Destroys the configuration object.
*/
QWifiConfiguration::~QWifiConfiguration()
{
    delete d_ptr;
}

/*!
    \property QWifiConfiguration::ssid
    \brief a human-readable name of a Wifi network
*/
QString QWifiConfiguration::ssid() const
{
    Q_D(const QWifiConfiguration);
    return d->m_ssid;
}

void QWifiConfiguration::setSsid(const QString &ssid)
{
    Q_D(QWifiConfiguration);
    d->m_ssid = ssid;
}

/*!
    \property QWifiConfiguration::passphrase
    \brief a passphrase to use for authenticating access to a network
*/
QString QWifiConfiguration::passphrase() const
{
    Q_D(const QWifiConfiguration);
    return d->m_psk;
}

void QWifiConfiguration::setPassphrase(const QString &passphrase)
{
    Q_D(QWifiConfiguration);
    d->m_psk = passphrase;
}

/*!
    \property QWifiConfiguration::protocol
    \brief a security protocol to use for Wifi connection

    WPA is used by default if protocol is not explicitly set.
    Supported values are: WPA, WPA2, WEP, WPS.
*/
QString QWifiConfiguration::protocol() const
{
    Q_D(const QWifiConfiguration);
    return d->m_protocol;
}

void QWifiConfiguration::setProtocol(const QString &protocol)
{
    Q_D(QWifiConfiguration);
    d->m_protocol = protocol;
}

QT_END_NAMESPACE