org::kde::kirigami::AboutPage

Search for usage in LXR

org::kde::kirigami::AboutPage Class Reference
Inheritance diagram for org::kde::kirigami::AboutPage:

Properties

alias _content
 
alias aboutData
 
alias donateUrl
 
alias getInvolvedUrl
 
- Properties inherited from org::kde::kirigami::ScrollablePage
Flickable flickable
 
int horizontalScrollBarPolicy
 
bool keyboardNavigationEnabled
 
QtObject mainItem
 
bool refreshing
 
alias scrollablePageChildren
 
alias scrollablePageData
 
bool supportsRefreshing
 
int verticalScrollBarPolicy
 
- Properties inherited from org::kde::kirigami::Page
ActionIconGroup
 
alias actions
 
alias contextualActions
 
Flickable flickable
 
Item globalToolBarItem
 
int globalToolBarStyle
 
bool isCurrentPage
 
alias leftAction
 
alias mainAction
 
bool needsAttention
 
alias overlay
 
var progress
 
alias rightAction
 
Component titleDelegate
 

Additional Inherited Members

- Signals inherited from org::kde::kirigami::Page
void backRequested (var event)
 
void contextualActionsAboutToShow ()
 

Detailed Description

This component is an "About" page that displays data about the application.

It allows showing the defined copyright notice of the application together with the contributors and some information of which platform it's running on.

See also
About Page in Kirigami
KDE Human Interface Guidelines on Application Information
kirigami::AboutItem
Since
KDE Frameworks 5.52
org.kde.kirigami 2.6

Definition at line 26 of file AboutPage.qml.

Property Documentation

◆ _content

alias org::kde::kirigami::AboutPage::_content
read
Remarks
This is the default property

Definition at line 94 of file AboutPage.qml.

◆ aboutData

KAboutData org::kde::kirigami::AboutPage::aboutData
read

This property holds a JSON object with the structure of KAboutData that will be displayed by the AboutPage.

See also
KAboutData

Note that displayName, version, description, and authors keys are mandatory, while the rest of the keys are optional. Make sure to fill out as many optional keys as you can to provide more accurate crediting information, especially copyrightStatement, which facilitates the management of the licenses used in your program.

Example usage:

aboutData: {
"displayName" : "KirigamiApp",
"productName" : "kirigami/app",
"componentName" : "kirigamiapp",
"shortDescription" : "A Kirigami example",
"homepage" : "",
"bugAddress" : "[email protected]",
"version" : "5.14.80",
"otherText" : "",
"authors" : [
{
"name" : "...",
"task" : "",
"emailAddress" : "[email protected]",
"webAddress" : "",
"ocsUsername" : ""
}
],
"credits" : [],
"translators" : [],
"licenses" : [
{
"name" : "GPL v2",
"text" : "long, boring, license text",
"spdx" : "GPL-2.0"
}
],
"copyrightStatement" : "© 2010-2018 Plasma Development Team",
"desktopFileName" : "org.kde.kirigamiapp"
}

Definition at line 76 of file AboutPage.qml.

◆ donateUrl

alias org::kde::kirigami::AboutPage::donateUrl
read

This property holds a link to a "Donate" page.

Since
KDE Frameworks 5.101

default: "https://kde.org/community/donations" when application id starts with "org.kde.", otherwise it is empty.

Definition at line 91 of file AboutPage.qml.

◆ getInvolvedUrl

url org::kde::kirigami::AboutPage::getInvolvedUrl
read

This property holds a link to a "Get Involved" page.

default: "https://community.kde.org/Get_Involved" when your application id starts with "org.kde.", otherwise is empty

Definition at line 84 of file AboutPage.qml.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Wed Sep 27 2023 03:57:55 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.