summaryrefslogtreecommitdiffstats
path: root/src/settingsui/settingsuiplugin/plugin.cpp
blob: 8ac64e10e19d91033e70fda7e86e25d5e06c3ff5 (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
/****************************************************************************
**
** 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 "plugin_p.h"
/*!
    \qmlmodule QtDeviceUtilities.SettingsUI
    \title Qt Device Utilities: Settings UI
    \ingroup qtdevice-utilities-qml-modules
    \ingroup qmlmodules
    \brief Provides a system-wide settings UI.

    The \c DeviceUtilities.SettingsUI module provides a single QML type,
    SettingsUI, that allows applications to integrate a standard, system-wide
    settings view into their user interface.

    To import and use the module's QML types, use the following statement:

    \badcode
    import QtDeviceUtilities.SettingsUI
    \endcode

    \section1 QML Types
*/

/*!
    \qmltype SettingsUI
    \inqmlmodule QtDeviceUtilities.SettingsUI
    \brief Provides a QML type for displaying a system-wide settings UI.

    With the SettingsUI type, applications can easily integrate a standard,
    system-wide settings view into their user interface.

    For example:

    \qml
    import QtQuick
    import QtDeviceUtilities.SettingsUI

    SettingsUI {
        id: settingsUI
        anchors.fill: parent
    }
    \endqml

    There is no need to import the various \c {DeviceUtilities.*} modules and
    to declare a custom settings UI, unless specifically required.
*/