summaryrefslogtreecommitdiffstats
path: root/src/wifi/qwificonfiguration.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/wifi/qwificonfiguration.cpp')
-rw-r--r--src/wifi/qwificonfiguration.cpp47
1 files changed, 37 insertions, 10 deletions
diff --git a/src/wifi/qwificonfiguration.cpp b/src/wifi/qwificonfiguration.cpp
index f2c859a..87ef440 100644
--- a/src/wifi/qwificonfiguration.cpp
+++ b/src/wifi/qwificonfiguration.cpp
@@ -38,6 +38,18 @@ QWifiConfigurationPrivate::QWifiConfigurationPrivate(QWifiConfiguration *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.
+ */
QWifiConfiguration::QWifiConfiguration(QObject *parent)
: QObject(parent)
@@ -50,40 +62,55 @@ QWifiConfiguration::~QWifiConfiguration()
delete d_ptr;
}
-void QWifiConfiguration::setSsid(const QString &ssid)
-{
- Q_D(QWifiConfiguration);
- d->m_ssid = ssid;
-}
-
+/*!
+ \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::setPassphrase(const QString &psk)
+void QWifiConfiguration::setSsid(const QString &ssid)
{
Q_D(QWifiConfiguration);
- d->m_psk = psk;
+ 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::setProtocol(const QString &protocol)
+void QWifiConfiguration::setPassphrase(const QString &passphrase)
{
Q_D(QWifiConfiguration);
- d->m_protocol = protocol;
+ 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