Kirigami2

AboutPage.qml
1/*
2 * SPDX-FileCopyrightText: 2018 Aleix Pol Gonzalez <aleixpol@blue-systems.com>
3 * SPDX-FileCopyrightText: 2023 ivan tkachenko <me@ratijas.tk>
4 *
5 * SPDX-License-Identifier: LGPL-2.0-or-later
6 */
7
8import QtQuick
9import org.kde.kirigami as Kirigami
10
11//TODO KF6: move somewhere else? kirigami addons?
12/**
13 * @brief An "About" page that is ready to integrate in a Kirigami app.
14 *
15 * Allows to have a page that will show the copyright notice of the application
16 * together with the contributors and some information of which platform it's
17 * running on.
18 *
19 * @since 5.52
20 * @since org.kde.kirigami 2.6
21 * @inherit org::kde::kirigami::ScrollablePage
22 */
23Kirigami.ScrollablePage {
24 id: page
25
26//BEGIN properties
27 /**
28 * @brief This property holds an object with the same shape as KAboutData.
29 *
30 * For example:
31 * @code{json}
32 * aboutData: {
33 "displayName" : "KirigamiApp",
34 "productName" : "kirigami/app",
35 "componentName" : "kirigamiapp",
36 "shortDescription" : "A Kirigami example",
37 "homepage" : "",
38 "bugAddress" : "submit@bugs.kde.org",
39 "version" : "5.14.80",
40 "otherText" : "",
41 "authors" : [
42 {
43 "name" : "...",
44 "task" : "",
45 "emailAddress" : "somebody@kde.org",
46 "webAddress" : "",
47 "ocsUsername" : ""
48 }
49 ],
50 "credits" : [],
51 "translators" : [],
52 "licenses" : [
53 {
54 "name" : "GPL v2",
55 "text" : "long, boring, license text",
56 "spdx" : "GPL-2.0"
57 }
58 ],
59 "copyrightStatement" : "© 2010-2018 Plasma Development Team",
60 "desktopFileName" : "org.kde.kirigamiapp"
61 }
62 @endcode
63 *
64 * @see KAboutData
65 * @see org::kde::kirigami::AboutItem::aboutData
66 * @property KAboutData aboutData
67 */
68 property alias aboutData: aboutItem.aboutData
69
70 /**
71 * @brief This property holds a link to a "Get Involved" page.
72 *
73 * default: `"https://community.kde.org/Get_Involved" when your application id starts with "org.kde.", otherwise is empty`
74 *
75 * @property url getInvolvedUrl
76 */
77 property alias getInvolvedUrl: aboutItem.getInvolvedUrl
78
79 /**
80 * @brief This property holds a link to a "Donate" page.
81 * @since 5.101
82 *
83 * default: `"https://kde.org/community/donations" when application id starts with "org.kde.", otherwise it is empty.`
84 */
85 property alias donateUrl: aboutItem.donateUrl
86
87 /**
88 * @brief This property controls whether to load avatars by URL.
89 *
90 * If set to false, a fallback "user" icon will be displayed.
91 *
92 * default: ``false``
93 */
94 property alias loadAvatars: aboutItem.loadAvatars
95
96 /** @internal */
97 default property alias _content: aboutItem._content
98//END properties
99
100 title: qsTr("About %1").arg(page.aboutData.displayName)
101
102 Kirigami.AboutItem {
103 id: aboutItem
104 wideMode: page.width >= aboutItem.implicitWidth
105
106 _usePageStack: applicationWindow().pageStack ? true : false
107 }
108}
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:52:23 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.