summaryrefslogtreecommitdiffstats
path: root/src/networksettings/networksettingsqml/qnetworksettingsforeign.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/networksettings/networksettingsqml/qnetworksettingsforeign.cpp')
-rw-r--r--src/networksettings/networksettingsqml/qnetworksettingsforeign.cpp151
1 files changed, 151 insertions, 0 deletions
diff --git a/src/networksettings/networksettingsqml/qnetworksettingsforeign.cpp b/src/networksettings/networksettingsqml/qnetworksettingsforeign.cpp
new file mode 100644
index 0000000..e3d1414
--- /dev/null
+++ b/src/networksettings/networksettingsqml/qnetworksettingsforeign.cpp
@@ -0,0 +1,151 @@
+/****************************************************************************
+**
+** 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 "qnetworksettingsforeign.h"
+
+/*!
+ \qmlmodule QtDeviceUtilities.NetworkSettings
+ \ingroup qtdevice-utilities-qml-modules
+ \ingroup qmlmodules
+ \title Qt Network Settings QML Types
+
+ \brief Provides singleton QML types for controlling network settings.
+
+ Qt Network Settings QML module provides singleton QML types for controlling
+ network settings in an embedded device.
+
+ To import and use the module's QML types, use the following statement:
+
+ \badcode
+ import QtDeviceUtilities.NetworkSettings
+ \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.
+*/