summaryrefslogtreecommitdiffstats
path: root/src/bluetoothsettings/bluetoothdevice.cpp
blob: 01de4bc4f8b8deda3d7c0cfaf44ffe484b578fd2 (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
/****************************************************************************
**
** 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 <discoverymodel.h>
#include "bluetoothdevice.h"
#include "bluetoothdevice_p.h"

QT_BEGIN_NAMESPACE

/*!
    \class BluetoothDevice
    \inmodule QtDeviceUtilities

    \brief The BluetoothDevice class controls Bluetooth settings.

    The Bluetooth settings contain information about the local Bluetooth device,
    such as the device model and whether the device is powered on and available
    for connections with other Bluetooth devices.

    The Bluetooth device can scan for other Bluetooth devices in range and
    retrieve information about them. The Bluetooth device then uses the address
    of another device to attempt pairing to it, and connects to it if the
    pairing was successful.
*/

/*!
    \property BluetoothDevice::scanning
    \brief Whether the Bluetooth device is scanning for remote devices.
*/

/*!
    \property BluetoothDevice::powered
    \brief Whether the power in the Bluetooth device is on or off.
*/

/*!
    \property BluetoothDevice::available
    \brief Whether the Bluetooth device is available.
*/

/*!
    \property BluetoothDevice::deviceModel
    \brief The model of the Bluetooth device.
*/

/*!
    Creates a new Bluetooth device with the parent \a parent.
*/
BluetoothDevice::BluetoothDevice(QObject *parent) : QObject(parent)
  ,d_ptr(new BluetoothDevicePrivate(this))
{
}

/*!
    Returns \c true if the power is switched on in the Bluetooth device.
*/
bool BluetoothDevice::powered() const
{
    Q_D(const BluetoothDevice);
    return d->powered();
}

/*!
    Sets the powered state in the Bluetooth device to \a aPowered.
*/
void BluetoothDevice::setPowered(const bool& aPowered)
{
    Q_D(BluetoothDevice);
    d->setPowered(aPowered);
}

/*!
    Returns the model of the Bluetooth device.
*/
DiscoveryModel* BluetoothDevice::deviceModel() const
{
    Q_D(const BluetoothDevice);
    return d->deviceModel();
}

/*!
    Returns whether the Bluetooth device is scanning for remote devices.
*/
bool BluetoothDevice::scanning() const
{
    Q_D(const BluetoothDevice);
    return d->scanning();
}

/*!
    Sets scanning in the Bluetooth device to \a aScan.
*/
void BluetoothDevice::setScanning(const bool& aScan)
{
    Q_D(BluetoothDevice);
    d->setScanning(aScan);
}

/*!
    Starts the process of pairing to a remote device specified by \a address,
    and connects to it if the pairing was successful.

    \sa requestConnect
*/
void BluetoothDevice::requestPairing(const QString& address)
{
    Q_D(BluetoothDevice);
    d->requestPairing(address);
}

/*!
    Connects to the remote device specified by \a address.
*/
void BluetoothDevice::requestConnect(const QString& address)
{
    Q_D(BluetoothDevice);
    d->requestConnect(address);
}

/*!
    Disconnects from the remote device specified by \a address.
*/
void BluetoothDevice::requestDisconnect(const QString& address)
{
    Q_D(BluetoothDevice);
    d->requestDisconnect(address);
}

/*!
    Returns the availability of the Bluetooth device.
*/
bool BluetoothDevice::available() const
{
    Q_D(const BluetoothDevice);
    return d->available();
}

QT_END_NAMESPACE