summaryrefslogtreecommitdiffstats
path: root/src/networksettings/qnetworksettingsinterface.cpp
blob: fcde01ac9d3a1cb3352ae12a511f8a7488650ed1 (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) 2016 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 "qnetworksettingsinterface.h"
#include "qnetworksettingsinterface_p.h"
#include "qnetworksettings.h"

/*!
    \qmltype NetworkInterface
    \inqmlmodule QtDeviceUtilities.NetworkSettings
    \brief Represents a network interface.

    The NetworkInterface QML type represents a network interface attached
    to the host.

    Instances of NetworkInterface cannot be created directly; instead, they can
    be retrieved via NetworkSettingsManager.

    \sa {NetworkSettingsManager::interfaces}{NetworkSettingsManager.interfaces}
*/

QNetworkSettingsInterface::QNetworkSettingsInterface(QObject *parent) :
    QObject(parent)
    ,d_ptr(new QNetworkSettingsInterfacePrivate(this))
{

}

/*!
    \qmlproperty string NetworkInterface::name
    \readonly
    \brief Holds the name of the network interface.
*/
QString QNetworkSettingsInterface::name() const
{
    Q_D(const QNetworkSettingsInterface);
    return d->m_name;
}

/*!
    \qmlproperty enumeration NetworkInterface::state
    \readonly
    \brief Holds the state of the network interface.

    Possible values:

    \value NetworkSettingsState.Idle
           Idle

    \value NetworkSettingsState.Failure
           Failed to connect

    \value NetworkSettingsState.Association
           Authentication in progress

    \value NetworkSettingsState.Configuration
           Configuration in progress

    \value NetworkSettingsState.Ready
           Connected to a network

    \value NetworkSettingsState.Disconnect
           Disconnected from a network

    \value NetworkSettingsState.Online
           Online (acquired an IP address)

    \value NetworkSettingsState.Undefined
           Undefined state.
*/
QNetworkSettingsState::States QNetworkSettingsInterface::state()
{
    Q_D(QNetworkSettingsInterface);
    return d->m_state.state();
}

/*!
    \qmlproperty enumeration NetworkInterface::type
    \readonly
    \brief Holds the type of the network interface.

    Possible values:

    \value NetworkSettingsType.Wired     Wired network
    \value NetworkSettingsType.Wifi      Wifi network
    \value NetworkSettingsType.Bluetooth Bluetooth network
    \value NetworkSettingsType.Unknown   Unknown network type
*/
QNetworkSettingsType::Types QNetworkSettingsInterface::type()
{
    Q_D(QNetworkSettingsInterface);
    return d->m_type.type();
}

/*!
    \qmlproperty bool NetworkInterface::powered
    \brief Holds whether the network interface is powered on of off.
*/
bool QNetworkSettingsInterface::powered() const
{
    Q_D(const QNetworkSettingsInterface);
    return d->m_powered;
}

void QNetworkSettingsInterface::setPowered(const bool powered)
{
    Q_D(QNetworkSettingsInterface);
    d->setPowered(powered);
}

/*!
    \qmlmethod void NetworkInterface::scanServices()
    \brief Initiates a scan for network interface services.
*/
void QNetworkSettingsInterface::scanServices()
{
    Q_D(QNetworkSettingsInterface);
    d->scan();
}