KAboutRelease Class

An individual release note of a program or plugin. More...

Header: #include <KAboutRelease>
CMake: find_package(KF6 REQUIRED COMPONENTS CoreAddons)
target_link_libraries(mytarget PRIVATE KF6::CoreAddons)
Since: 6.26

Properties

Public Functions

QDate date() const
QString description() const
QString untranslatedDescription() const
QUrl url() const
QString version() const

Detailed Description

This represents an AppStream release note of an individual version.

\seehttps://www.freedesktop.org/software/appstream/docs/sect-Metadata-Releases.html

Property Documentation

[read-only] date : QDate

Access functions:

QDate date() const

[read-only] description : QString

Access functions:

QString description() const

[read-only] url : QUrl

Access functions:

QUrl url() const

[read-only] version : QString

Access functions:

QString version() const

Member Function Documentation

QDate KAboutRelease::date() const

Returns the date on which this version was released.

Note: Getter function for property date.

QString KAboutRelease::description() const

Returns the (translated) release notes.

This is provided as restricted rich text, following what the description tag in AppStream allows. This is suitable for consumption by Qt rich text labels.

Note: Getter function for property description.

QString KAboutRelease::untranslatedDescription() const

Returns the untranslated release notes.

This is not meant for displaying to users, but for detecting changes since the last display, when display release notes on development versions.

\seedescription

QUrl KAboutRelease::url() const

Returns a URL to a website with more information about the release.

Note: Getter function for property url.

QString KAboutRelease::version() const

Retursn the version this release note refers to.

Note: Getter function for property version.