summaryrefslogtreecommitdiffstats
path: root/src/imports/wifi/qwifinetwork.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/imports/wifi/qwifinetwork.cpp')
-rw-r--r--src/imports/wifi/qwifinetwork.cpp74
1 files changed, 74 insertions, 0 deletions
diff --git a/src/imports/wifi/qwifinetwork.cpp b/src/imports/wifi/qwifinetwork.cpp
index a159e59..2ff8d7b 100644
--- a/src/imports/wifi/qwifinetwork.cpp
+++ b/src/imports/wifi/qwifinetwork.cpp
@@ -18,6 +18,80 @@
****************************************************************************/
#include "qwifinetwork.h"
+/*!
+ \qmltype WifiNetwork
+ \inqmlmodule Qt.labs.wifi
+ \brief WifiNetwork represents a single wifi network access point.
+
+ Instances of WifiNetwork cannot be created directly from the QML system, use
+ WifiManager::networks.
+*/
+
+/*!
+ \qmlproperty string WifiNetwork::bssid
+
+ This property holds basic service set identification of a network, used to uniquely
+ identify BSS.
+
+*/
+
+/*!
+ \qmlproperty string WifiNetwork::ssid
+
+ This property holds a network name. The SSID is the informal (human) name of BSS.
+*/
+
+/*!
+ \qmlproperty int WifiNetwork::signalStrength
+
+ This property holds the current strength of a WiFi signal. New readings are
+ taken every 5 seconds.
+
+ \sa signalStrengthChanged
+*/
+
+/*!
+ \qmlproperty bool WifiNetwork::supportsWPA
+
+ This property holds whether network access point supports WPA security protocol.
+*/
+
+/*!
+ \qmlproperty bool WifiNetwork::supportsWPA2
+
+ This property holds whether network access point supports WPA2 security protocol.
+*/
+
+/*!
+ \qmlproperty bool WifiNetwork::supportsWEP
+
+ This property holds whether network access point supports WEP security protocol.
+*/
+
+/*!
+ \qmlproperty bool WifiNetwork::supportsWPS
+
+ This property holds whether network access point supports WPS security protocol.
+*/
+
+/*!
+ \qmlsignal void WifiNetwork::signalStrengthChanged(int strength)
+
+ This signal is emitted whenever signal strength has changed comparing the the
+ previous reading, the new signal's strength is \a strength.
+
+ \code
+ function handleStrengthChanged(currentStrength) {
+ if (currentStrength < UNTOLERABLE_SPEED)
+ print("network speed has dropped under " + UNTOLERABLE_SPEED)
+ }
+
+ Component.onCompleted: {
+ network.onSignalStrengthChanged.connect(handleStrengthChanged)
+ }
+ \endcode
+*/
+
QWifiNetwork::QWifiNetwork()
{
}