summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qtdeviceutilities-index.qdoc
blob: 3e4467eac466b82e8c4926a3aa6c294b4f9ef043 (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
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page qtdeviceutilities-index.html
    \maintitle
    \brief Provides functionality for controlling settings in embedded applications.

    \QtDU provides functionality that is useful for controlling settings in embedded
    applications. \QtDU provides the following C++ modules:

    \annotatedlist qtdevice-utilities-cpp-modules

    \QtDU provides the following QML modules:

    \annotatedlist qtdevice-utilities-qml-modules

    \section1 Getting Started

    To include the definitions of the module's class, use the following
    directive:

    \badcode
    #include <QtNetworkSettings>
    \endcode

    \section2 Building with CMake

    If you're using CMake to build your application, add the following lines to your CMakeLists.txt file:

    \badcode
    find_package(Qt6 COMPONENTS NetworkSettings REQUIRED)
    target_link_libraries(mytarget Qt6::NetworkSettings)
    \endcode

    \section2 Building with qmake

    If you're using qmake to build your application, add this line to your qmake .pro file:

    \badcode
    QT += networksettings
    \endcode

    To import the QML types into your application, use the following import
    statements in your .qml file:

    \code
    import QtDeviceUtilities.NetworkSettings
    import QtDeviceUtilities.SettingsUI
    \endcode

    \section1 Examples

    \list
      \li \l {Qt Device Utilities Examples}
    \endlist

    \section1 Reference

    \list
      \li \l {Qt Device Utilities C++ Classes}
      \li \l {Qt Device Utilities QML Types}
    \endlist
*/