Kirigami-addons

ConfigurationModule.qml
1// SPDX-FileCopyrightText: 2021 Carl Schwan <carl@carlschwan.eu>
2// SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
3
4import QtQml
5import org.kde.kirigamiaddons.settings.private as Private
6
7/**
8 * This object holds the information of configuration module.
9 * @since KirigamiAddons 1.3.0
10 */
11QtObject {
12 id: root
13
14 /**
15 * @brief This property holds the id of the module for when it needs to be referenced.
16 *
17 * Primary use case if for setting a default module in ConfigDialog
18 */
19 required property string moduleId
20
21 /**
22 * This property holds the name of the module. This will be displayed in the
23 * list of modules.
24 */
25 required property string text
27 /**
28 * This property holds the icon of the module.
29 */
30 readonly property Private.ActionIconGroup icon: Private.ActionIconGroup {}
31
32 /**
33 * This property holds a function that returns a Component
34 */
35 required property var page
36
37 /**
38 * This property holds whether the module is visible.
39 */
40 property bool visible: true
41
42 /**
43 * This property holds the initial property that the page needs to be initialized with
44 * if any.
45 *
46 * This is a function that returns an Javascript object.
47 *
48 * @code{qml}
49 * initialProperties: () => {
50 * return {
51 * room: root._room,
52 * connection: root._connection
53 * };
54 * }
55 * @endcode
56 */
57 property var initialProperties: () => {
58 return {};
59 }
60
61 /**
62 * This property holds the category of the module. This will be used to group
63 * modules together on mobile.
64 *
65 * Do not overwrite the default value, if you want your module to
66 * be grouped in the default category.
67 */
68 property string category: "_main_category"
69}
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:05:53 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.