KAboutData Class Reference
from PyKDE5.kcoreaddons import *
Detailed Description
This class is used to store information about a program or plugin. It can store such values as version number, program name, home page, email address for bug reporting, multiple authors and contributors (using KAboutPerson), license and copyright information.
Currently, the values set here are shown by the "About" box (see KAboutDialog), used by the bug report dialog (see KBugReport), and by the help shown on command line (see KAboutData.setupCommandLine()).
Porting Notes: Since KDE Frameworks 5.0, the translation catalog mechanism must provided by your translation framework to load the correct catalog instead (eg: KLocalizedString.setApplicationDomain() for KI18n, or QCoreApplication.installTranslator() for Qt's translation system). This applies to the old setCatalogName() and catalogName() members. But see also K4AboutData in kde4support as a compatibility class.
Holds information needed by the "About" box and other classes.
Methods | |
__init__ (self, KAboutData other) | |
__init__ (self, QString componentName, QString displayName, QString version, QString shortDescription, KAboutLicense::LicenseKey licenseType, QString copyrightStatement=QString(), QString otherText=QString(), QString homePageAddress=QString(), QString bugsEmailAddress=QLatin1String("submit@bugs.kde.org")) | |
__init__ (self, QString componentName, QString displayName, QString version) | |
KAboutData | addAuthor (self, QString name, QString task=QString(), QString emailAddress=QString(), QString webAddress=QString(), QString ocsUsername=QString()) |
KAboutData | addCredit (self, QString name, QString task=QString(), QString emailAddress=QString(), QString webAddress=QString(), QString ocsUserName=QString()) |
KAboutData | addLicense (self, KAboutLicense::LicenseKey licenseKey) |
KAboutData | addLicenseText (self, QString license) |
KAboutData | addLicenseTextFile (self, QString file) |
[KAboutPerson] | authors (self) |
QString | bugAddress (self) |
QString | componentName (self) |
QString | copyrightStatement (self) |
[KAboutPerson] | credits (self) |
QString | customAuthorPlainText (self) |
QString | customAuthorRichText (self) |
bool | customAuthorTextEnabled (self) |
QString | displayName (self) |
QString | homepage (self) |
QString | internalBugAddress (self) |
QString | internalProgramName (self) |
QString | internalVersion (self) |
[KAboutLicense] | licenses (self) |
QString | ocsProviderUrl (self) |
QString | organizationDomain (self) |
QString | otherText (self) |
QString | productName (self) |
QString | programIconName (self) |
QVariant | programLogo (self) |
KAboutData | setBugAddress (self, QByteArray bugAddress) |
KAboutData | setComponentName (self, QString componentName) |
KAboutData | setCopyrightStatement (self, QString copyrightStatement) |
KAboutData | setCustomAuthorText (self, QString plainText, QString richText) |
KAboutData | setDisplayName (self, QString displayName) |
KAboutData | setHomepage (self, QString homepage) |
KAboutData | setLicense (self, KAboutLicense::LicenseKey licenseKey) |
KAboutData | setLicenseText (self, QString license) |
KAboutData | setLicenseTextFile (self, QString file) |
KAboutData | setOcsProvider (self, QString providerUrl) |
KAboutData | setOrganizationDomain (self, QByteArray domain) |
KAboutData | setOtherText (self, QString otherText) |
KAboutData | setProductName (self, QByteArray name) |
KAboutData | setProgramIconName (self, QString iconName) |
KAboutData | setProgramLogo (self, QVariant image) |
KAboutData | setShortDescription (self, QString shortDescription) |
KAboutData | setTranslator (self, QString name, QString emailAddress) |
KAboutData | setVersion (self, QByteArray version) |
QString | shortDescription (self) |
[KAboutPerson] | translators (self) |
KAboutData | unsetCustomAuthorText (self) |
QString | version (self) |
Static Methods | |
QString | aboutTranslationTeam () |
KAboutData | applicationData () |
KAboutData | pluginData (QString componentName) |
registerPluginData (KAboutData aboutData) | |
setApplicationData (KAboutData aboutData) |
Method Documentation
__init__ | ( | self, | ||
KAboutData | other | |||
) |
Copy constructor. Performs a deep copy.
- Parameters:
-
other object to copy
__init__ | ( | self, | ||
QString | componentName, | |||
QString | displayName, | |||
QString | version, | |||
QString | shortDescription, | |||
KAboutLicense::LicenseKey | licenseType, | |||
QString | copyrightStatement=QString(), | |||
QString | otherText=QString(), | |||
QString | homePageAddress=QString(), | |||
QString | bugsEmailAddress=QLatin1String("submit@bugs.kde.org") | |||
) |
Constructor.
Porting Note: The catalogName parameter present in KDE4 was deprecated and removed. See also K4AboutData in kde4support if this feature is needed for compatibility purposes, or consider using componentName() instead.
- Parameters:
-
componentName The program name or plugin name used internally. Example: "kwrite". displayName A displayable name for the program or plugin. This string should be translated. Example: i18n("KWrite") version The component version string. shortDescription A short description of what the component does. This string should be translated. Example: i18n("A simple text editor.") licenseType The license identifier. Use setLicenseText or setLicenseTextFile if you use a license not predefined here. copyrightStatement A copyright statement, that can look like this: i18n("Copyright (C) 1999-2000 Name"). The string specified here is taken verbatim; the author information from addAuthor is not used. otherText Some free form text, that can contain any kind of information. The text can contain newlines. This string should be translated. homePageAddress The component's homepage string. Start the address with "http://". "http://some.domain" is is correct, "some.domain" is not. IMPORTANT: if you set a home page address, this will change the "organization domain" of the application, which is used for automatic D-Bus registration.
- See also:
- setOrganizationDomain
- Parameters:
-
bugsEmailAddress The bug report email address string. This defaults to the kde.org bug system.
__init__ | ( | self, | ||
QString | componentName, | |||
QString | displayName, | |||
QString | version | |||
) |
Constructor.
- Parameters:
-
componentName The program name or plugin name used internally. Example: "kwrite". displayName A displayable name for the program or plugin. This string should be translated. Example: i18n("KWrite") version The component version string.
KAboutData addAuthor | ( | self, | ||
QString | name, | |||
QString | task=QString(), | |||
QString | emailAddress=QString(), | |||
QString | webAddress=QString(), | |||
QString | ocsUsername=QString() | |||
) |
Defines an author.
You can call this function as many times as you need. Each entry is appended to a list. The person in the first entry is assumed to be the leader of the project.
- Parameters: