src/controls/AboutPage.qml

0001 /*
0002  *  SPDX-FileCopyrightText: 2018 Aleix Pol Gonzalez <aleixpol@blue-systems.com>
0003  *  SPDX-FileCopyrightText: 2023 ivan tkachenko <me@ratijas.tk>
0004  *
0005  *  SPDX-License-Identifier: LGPL-2.0-or-later
0006  */
0007
0008 import QtQuick
0009 import QtQuick.Controls as QQC2
0010 import QtQuick.Layouts
0011 import org.kde.kirigami as Kirigami
0012
0013 //TODO KF6: move somewhere else? kirigami addons?
0014 /**
0015  * @brief An "About" page that is ready to integrate in a Kirigami app.
0016  *
0017  * Allows to have a page that will show the copyright notice of the application
0018  * together with the contributors and some information of which platform it's
0019  * running on.
0020  *
0021  * @since 5.52
0022  * @since org.kde.kirigami 2.6
0023  * @inherit org::kde::kirigami::ScrollablePage
0024  */
0025 Kirigami.ScrollablePage {
0026     id: page
0027
0028 //BEGIN properties
0029     /**
0030      * @brief This property holds an object with the same shape as KAboutData.
0031      *
0032      * For example:
0033      * @code{json}
0034      * aboutData: {
0035           "displayName" : "KirigamiApp",
0036           "productName" : "kirigami/app",
0037           "componentName" : "kirigamiapp",
0038           "shortDescription" : "A Kirigami example",
0039           "homepage" : "",
0040           "bugAddress" : "submit@bugs.kde.org",
0041           "version" : "5.14.80",
0042           "otherText" : "",
0043           "authors" : [
0044               {
0045                   "name" : "...",
0046                   "task" : "",
0047                   "emailAddress" : "somebody@kde.org",
0048                   "webAddress" : "",
0049                   "ocsUsername" : ""
0050               }
0051           ],
0052           "credits" : [],
0053           "translators" : [],
0054           "licenses" : [
0055               {
0056                   "name" : "GPL v2",
0057                   "text" : "long, boring, license text",
0058                   "spdx" : "GPL-2.0"
0059               }
0060           ],
0061           "copyrightStatement" : "© 2010-2018 Plasma Development Team",
0062           "desktopFileName" : "org.kde.kirigamiapp"
0063        }
0064        @endcode
0065      *
0066      * @see KAboutData
0067      * @see org::kde::kirigami::AboutItem::aboutData
0068      * @property KAboutData aboutData
0069      */
0070     property alias aboutData: aboutItem.aboutData
0071
0072     /**
0073      * @brief This property holds a link to a "Get Involved" page.
0074      *
0075      * default: `"https://community.kde.org/Get_Involved" when your application id starts with "org.kde.", otherwise is empty`
0076      *
0077      * @property url getInvolvedUrl
0078      */
0079     property alias getInvolvedUrl: aboutItem.getInvolvedUrl
0080
0081     /**
0082      * @brief This property holds a link to a "Donate" page.
0083      * @since 5.101
0084      *
0085      * default: `"https://kde.org/community/donations" when application id starts with "org.kde.", otherwise it is empty.`
0086      */
0087     property alias donateUrl: aboutItem.donateUrl
0088
0089     /**
0090      * @brief This property controls whether to load avatars by URL.
0091      *
0092      * If set to false, a fallback "user" icon will be displayed.
0093      *
0094      * default: ``false``
0095      */
0096     property alias loadAvatars: aboutItem.loadAvatars
0097
0098     /** @internal */
0099     default property alias _content: aboutItem._content
0100 //END properties
0101
0102     title: qsTr("About %1").arg(page.aboutData.displayName)
0103
0104     Kirigami.AboutItem {
0105         id: aboutItem
0106         wideMode: page.width >= aboutItem.implicitWidth
0107
0108         _usePageStack: applicationWindow().pageStack ? true : false
0109     }
0110 }