summaryrefslogtreecommitdiffstats
path: root/src/networksettings/qnetworksettingsinterface.cpp
blob: 7bf6ae0115dbc8ba049794689a4a3f19ffeb3215 (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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/****************************************************************************
**
** 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"

QT_BEGIN_NAMESPACE

/*!
    \class QNetworkSettingsInterface
    \inmodule QtDeviceUtilities
    \brief Represents a network interface.

    The QNetworkSettingsInterface class represents a network interface attached
    to the host.

    Instances of this class cannot be created directly. Instead, they can be
    retrieved via QNetworkSettingsManager::interfaces().
*/

/*!
    \property QNetworkSettingsInterface::state
    \readonly
    \brief Holds the state of the network interface.

    \sa QNetworkSettingsState::States
*/

/*!
    \property QNetworkSettingsInterface::name
    \readonly
    \brief Holds the name of the network interface.
*/

/*!
    \property QNetworkSettingsInterface::powered
    \brief Holds whether the network interface is powered on of off.
*/

/*!
    \property QNetworkSettingsInterface::type
    \readonly
    \brief Holds the type of the network interface.

    \sa QNetworkSettingsType::Types
*/

/*!
    \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}
*/


/*!
    Creates a new network interface with the parent \a parent.
*/
QNetworkSettingsInterface::QNetworkSettingsInterface(QObject *parent) :
    QObject(parent)
    ,d_ptr(new QNetworkSettingsInterfacePrivate(this))
{

}

/*!
    \qmlproperty string NetworkInterface::name
    \readonly
    \brief Holds the name of the network interface.
*/

/*!
    Returns the name of the network interface.
*/
QString QNetworkSettingsInterface::name() const
{
    Q_D(const QNetworkSettingsInterface);
    return d->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.
*/

/*!
    Returns the state of the network interface.
*/
QNetworkSettingsState::States QNetworkSettingsInterface::state()
{
    Q_D(QNetworkSettingsInterface);
    return d->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
*/

/*!
    Returns the type of the network interface.
*/
QNetworkSettingsType::Types QNetworkSettingsInterface::type()
{
    Q_D(QNetworkSettingsInterface);
    return d->type();
}

/*!
    \qmlproperty bool NetworkInterface::powered
    \brief Holds whether the network interface is powered on or off.
*/

/*!
    Returns whether the network interface is powered on or off.
*/
bool QNetworkSettingsInterface::powered() const
{
    Q_D(const QNetworkSettingsInterface);
    return d->powered();
}

/*!
    Sets the powered state in the network interface to \a 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.
*/

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

QT_END_NAMESPACE