• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

KDECore

Public Types | Public Member Functions | Static Public Member Functions | List of all members
KAboutData Class Reference

#include <kaboutdata.h>

Public Types

enum  LicenseKey {
  License_Custom = -2, License_File = -1, License_Unknown = 0, License_GPL = 1,
  License_GPL_V2 = 1, License_LGPL = 2, License_LGPL_V2 = 2, License_BSD = 3,
  License_Artistic = 4, License_QPL = 5, License_QPL_V1_0 = 5, License_GPL_V3 = 6,
  License_LGPL_V3 = 7
}
 
enum  NameFormat { ShortName, FullName }
 

Public Member Functions

 KAboutData (const QByteArray &appName, const QByteArray &catalogName, const KLocalizedString &programName, const QByteArray &version, const KLocalizedString &shortDescription=KLocalizedString(), enum LicenseKey licenseType=License_Unknown, const KLocalizedString &copyrightStatement=KLocalizedString(), const KLocalizedString &otherText=KLocalizedString(), const QByteArray &homePageAddress=QByteArray(), const QByteArray &bugsEmailAddress="submit@bugs.kde.org")
 
 KAboutData (const KAboutData &other)
 
 ~KAboutData ()
 
KAboutData & addAuthor (const KLocalizedString &name, const KLocalizedString &task=KLocalizedString(), const QByteArray &emailAddress=QByteArray(), const QByteArray &webAddress=QByteArray())
 
KAboutData & addAuthor (const KLocalizedString &name, const KLocalizedString &task, const QByteArray &emailAddress, const QByteArray &webAddress, const QByteArray &ocsUsername)
 
KAboutData & addCredit (const KLocalizedString &name, const KLocalizedString &task=KLocalizedString(), const QByteArray &emailAddress=QByteArray(), const QByteArray &webAddress=QByteArray())
 
KAboutData & addCredit (const KLocalizedString &name, const KLocalizedString &task, const QByteArray &emailAddress, const QByteArray &webAddress, const QByteArray &ocsUsername)
 
KAboutData & addLicense (LicenseKey licenseKey)
 
KAboutData & addLicenseText (const KLocalizedString &license)
 
KAboutData & addLicenseTextFile (const QString &file)
 
QString appName () const
 
QList< KAboutPerson > authors () const
 
QString bugAddress () const
 
QString catalogName () const
 
QString copyrightStatement () const
 
QList< KAboutPerson > credits () const
 
QString customAuthorPlainText () const
 
QString customAuthorRichText () const
 
bool customAuthorTextEnabled () const
 
QString homepage () const
 
const char * internalBugAddress () const
 
const char * internalProgramName () const
 
const char * internalVersion () const
 
QString license () const
 
QString licenseName (NameFormat formatName) const
 
QList< KAboutLicense > licenses () const
 
QString ocsProviderUrl () const
 
KAboutData & operator= (const KAboutData &other)
 
QString organizationDomain () const
 
QString otherText () const
 
QString productName () const
 
QString programIconName () const
 
QVariant programLogo () const
 
QString programName () const
 
KAboutData & setAppName (const QByteArray &appName)
 
KAboutData & setBugAddress (const QByteArray &bugAddress)
 
KAboutData & setCatalogName (const QByteArray &catalogName)
 
KAboutData & setCopyrightStatement (const KLocalizedString &copyrightStatement)
 
KAboutData & setCustomAuthorText (const KLocalizedString &plainText, const KLocalizedString &richText)
 
KAboutData & setHomepage (const QByteArray &homepage)
 
KAboutData & setLicense (LicenseKey licenseKey)
 
KAboutData & setLicenseText (const KLocalizedString &license)
 
KAboutData & setLicenseTextFile (const QString &file)
 
KAboutData & setOcsProvider (const QByteArray &providerUrl)
 
KAboutData & setOrganizationDomain (const QByteArray &domain)
 
KAboutData & setOtherText (const KLocalizedString &otherText)
 
KAboutData & setProductName (const QByteArray &name)
 
KAboutData & setProgramIconName (const QString &iconName)
 
KAboutData & setProgramLogo (const QVariant &image)
 
KAboutData & setProgramName (const KLocalizedString &programName)
 
KAboutData & setShortDescription (const KLocalizedString &shortDescription)
 
KAboutData & setTranslator (const KLocalizedString &name, const KLocalizedString &emailAddress)
 
KAboutData & setVersion (const QByteArray &version)
 
QString shortDescription () const
 
void translateInternalProgramName () const
 
QList< KAboutPerson > translators () const
 
KAboutData & unsetCustomAuthorText ()
 
QString version () const
 

Static Public Member Functions

static QString aboutTranslationTeam ()
 

Detailed Description

This class is used to store information about a program.

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 KCmdLineArgs). They are also used for the icon and the name of the program's windows.

Note
Instead of the more usual i18n calls, for translatable text the ki18n calls are used to produce KLocalizedStrings, which can delay the translation lookup. This is necessary because the translation catalogs are usually not yet initialized at the point where KAboutData is constructed.

Holds information needed by the "About" box and other classes.

Author
Espen Sand (espen.nosp@m.@kde.nosp@m..org), David Faure (faure.nosp@m.@kde.nosp@m..org)

Definition at line 192 of file kaboutdata.h.

Member Enumeration Documentation

enum KAboutData::LicenseKey

Describes the license of the software.

Enumerator
License_Custom 
License_File 
License_Unknown 
License_GPL 
License_GPL_V2 
License_LGPL 
License_LGPL_V2 
License_BSD 
License_Artistic 
License_QPL 
License_QPL_V1_0 
License_GPL_V3 
License_LGPL_V3 

Definition at line 198 of file kaboutdata.h.

enum KAboutData::NameFormat

Format of the license name.

Enumerator
ShortName 
FullName 

Definition at line 218 of file kaboutdata.h.

Constructor & Destructor Documentation

KAboutData::KAboutData ( const QByteArray &  appName,
const QByteArray &  catalogName,
const KLocalizedString &  programName,
const QByteArray &  version,
const KLocalizedString &  shortDescription = KLocalizedString(),
enum LicenseKey  licenseType = License_Unknown,
const KLocalizedString &  copyrightStatement = KLocalizedString(),
const KLocalizedString &  otherText = KLocalizedString(),
const QByteArray &  homePageAddress = QByteArray(),
const QByteArray &  bugsEmailAddress = "submit@bugs.kde.org" 
)

Constructor.

Parameters
appNameThe program name used internally. Example: "kedit"
catalogNameThe translation catalog name; if null or empty, the appName will be used. You may want the catalog name to differ from program name, for example, when you want to group translations of several smaller utilities under the same catalog.
programNameA displayable program name string. This string should be marked for translation. Example: ki18n("KEdit")
versionThe program version string.
shortDescriptionA short description of what the program does. This string should be marked for translation. Example: ki18n("A simple text editor.")
licenseTypeThe license identifier. Use setLicenseText or setLicenseTextFile if you use a license not predefined here.
copyrightStatementA copyright statement, that can look like this: ki18n("Copyright (C) 1999-2000 Name"). The string specified here is taken verbatim; the author information from addAuthor is not used.
otherTextSome free form text, that can contain any kind of information. The text can contain newlines. This string should be marked for translation.
homePageAddressThe program 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
bugsEmailAddressThe bug report email address string. This defaults to the kde.org bug system.

Definition at line 427 of file kaboutdata.cpp.

KAboutData::KAboutData ( const KAboutData &  other)

Copy constructor.

Performs a deep copy.

Parameters
otherobject to copy

Definition at line 480 of file kaboutdata.cpp.

KAboutData::~KAboutData ( )

Definition at line 475 of file kaboutdata.cpp.

Member Function Documentation

QString KAboutData::aboutTranslationTeam ( )
static

Returns a message about the translation team.

Returns
a message about the translation team

Definition at line 872 of file kaboutdata.cpp.

KAboutData & KAboutData::addAuthor ( const KLocalizedString &  name,
const KLocalizedString &  task = KLocalizedString(),
const QByteArray &  emailAddress = QByteArray(),
const QByteArray &  webAddress = QByteArray() 
)

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
nameThe developer's name. It should be marked for translation like this: ki18n("Developer Name")
taskWhat the person is responsible for. This text can contain newlines. It should be marked for translation like this: ki18n("Task description..."). Can be left empty.
emailAddressAn Email address where the person can be reached. Can be left empty.
webAddressThe person's homepage or a relevant link. Start the address with "http://". "http://some.domain" is correct, "some.domain" is not. Can be left empty.

Definition at line 505 of file kaboutdata.cpp.

KAboutData & KAboutData::addAuthor ( const KLocalizedString &  name,
const KLocalizedString &  task,
const QByteArray &  emailAddress,
const QByteArray &  webAddress,
const QByteArray &  ocsUsername 
)

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
nameThe developer's name. It should be marked for translation like this: ki18n("Developer Name")
taskWhat the person is responsible for. This text can contain newlines. It should be marked for translation like this: ki18n("Task description..."). Can be left empty.
emailAddressAn Email address where the person can be reached. Can be left empty.
webAddressThe person's homepage or a relevant link. Start the address with "http://". "http://some.domain" is correct, "some.domain" is not. Can be left empty.
ocsUsernameThe person's Open Collaboration Services username. The provider can be optionally specified with
See also
setOcsProvider.

Definition at line 514 of file kaboutdata.cpp.

KAboutData & KAboutData::addCredit ( const KLocalizedString &  name,
const KLocalizedString &  task = KLocalizedString(),
const QByteArray &  emailAddress = QByteArray(),
const QByteArray &  webAddress = QByteArray() 
)

Defines a person that deserves credit.

You can call this function as many times as you need. Each entry is appended to a list.

Parameters
nameThe person's name. It should be marked for translation like this: ki18n("Contributor Name")
taskWhat the person has done to deserve the honor. The text can contain newlines. It should be marked for translation like this: ki18n("Task description...") Can be left empty.
emailAddressAn email address when the person can be reached. Can be left empty.
webAddressThe person's homepage or a relevant link. Start the address with "http://". "http://some.domain" is is correct, "some.domain" is not. Can be left empty.

Definition at line 524 of file kaboutdata.cpp.

KAboutData & KAboutData::addCredit ( const KLocalizedString &  name,
const KLocalizedString &  task,
const QByteArray &  emailAddress,
const QByteArray &  webAddress,
const QByteArray &  ocsUsername 
)

Defines a person that deserves credit.

You can call this function as many times as you need. Each entry is appended to a list.

Parameters
nameThe person's name. It should be marked for translation like this: ki18n("Contributor Name")
taskWhat the person has done to deserve the honor. The text can contain newlines. It should be marked for translation like this: ki18n("Task description...") Can be left empty.
emailAddressAn email address when the person can be reached. Can be left empty.
webAddressThe person's homepage or a relevant link. Start the address with "http://". "http://some.domain" is is correct, "some.domain" is not. Can be left empty.
ocsUsernameThe person's Open Collaboration Services username. The provider can be optionally specified with
See also
setOcsProvider.

Definition at line 533 of file kaboutdata.cpp.

KAboutData & KAboutData::addLicense ( LicenseKey  licenseKey)

Adds a license identifier.

If there is only one unknown license set, e.g. by using the default parameter in the constructor, that one is replaced.

Parameters
licenseKeyThe license identifier.
See also
setLicenseText, addLicenseText, addLicenseTextFile
Since
4.1

Definition at line 630 of file kaboutdata.cpp.

KAboutData & KAboutData::addLicenseText ( const KLocalizedString &  license)

Adds a license text, which is marked for translation.

If there is only one unknown license set, e.g. by using the default parameter in the constructor, that one is replaced.

Example:

addLicenseText( ki18n("This is my license") );
Parameters
licenseThe license text.
See also
setLicenseText, addLicense, addLicenseTextFile
Since
4.1

Definition at line 557 of file kaboutdata.cpp.

KAboutData & KAboutData::addLicenseTextFile ( const QString &  file)

Adds a license text by pointing to a file where it resides.

The file format has to be plain text in an encoding compatible to the locale.

If there is only one unknown license set, e.g. by using the default parameter in the constructor, that one is replaced.

Parameters
filePath to the file in the local filesystem containing the license text.
See also
addLicenseText, addLicense, setLicenseTextFile
Since
4.1

Definition at line 575 of file kaboutdata.cpp.

QString KAboutData::appName ( ) const

Returns the application's internal name.

Returns
the internal program name.

Definition at line 678 of file kaboutdata.cpp.

QList< KAboutPerson > KAboutData::authors ( ) const

Returns a list of authors.

Returns
author information (list of persons).

Definition at line 799 of file kaboutdata.cpp.

QString KAboutData::bugAddress ( ) const

Returns the email address for bugs.

Returns
the email address where to report bugs.

Definition at line 778 of file kaboutdata.cpp.

QString KAboutData::catalogName ( ) const

Returns the program's translation catalog name.

Returns
the catalog name.

Definition at line 765 of file kaboutdata.cpp.

QString KAboutData::copyrightStatement ( ) const

Returns the copyright statement.

Returns
the copyright statement. Can be QString() if not set.

Definition at line 904 of file kaboutdata.cpp.

QList< KAboutPerson > KAboutData::credits ( ) const

Returns a list of persons who contributed.

Returns
credit information (list of persons).

Definition at line 804 of file kaboutdata.cpp.

QString KAboutData::customAuthorPlainText ( ) const

Returns the plain text displayed around the list of authors instead of the default message telling users to send bug reports to bugAddress().

Returns
the plain text displayed around the list of authors instead of the default message. Can be QString().

Definition at line 911 of file kaboutdata.cpp.

QString KAboutData::customAuthorRichText ( ) const

Returns the rich text displayed around the list of authors instead of the default message telling users to send bug reports to bugAddress().

Returns
the rich text displayed around the list of authors instead of the default message. Can be QString().

Definition at line 918 of file kaboutdata.cpp.

bool KAboutData::customAuthorTextEnabled ( ) const

Returns whether custom text should be displayed around the list of authors.

Returns
whether custom text should be displayed around the list of authors.

Definition at line 925 of file kaboutdata.cpp.

QString KAboutData::homepage ( ) const

Returns the application homepage.

Returns
the application homepage URL. Can be QString() if not set.

Definition at line 773 of file kaboutdata.cpp.

const char * KAboutData::internalBugAddress ( ) const

Provided for use by KCrash

Return the untranslated and uninterpreted (to UTF8) string for the bug mail address. Used in particular for KCrash.

Definition at line 792 of file kaboutdata.cpp.

const char * KAboutData::internalProgramName ( ) const

Provided for use by KCrash

Return the program name. It is always pre-allocated. Needed for KCrash in particular.

Definition at line 700 of file kaboutdata.cpp.

const char * KAboutData::internalVersion ( ) const

Provided for use by KCrash

Return the untranslated and uninterpreted (to UTF8) string for the version information. Used in particular for KCrash.

Definition at line 753 of file kaboutdata.cpp.

QString KAboutData::license ( ) const

Returns the license.

If the licenseType argument of the constructor has been used, any text defined by setLicenseText is ignored, and the standard text for the chosen license will be returned.

Returns
The license text.
Deprecated:
There could be multiple licenses, use licenses() instead.

Definition at line 889 of file kaboutdata.cpp.

QString KAboutData::licenseName ( NameFormat  formatName) const

Returns the license name.

Returns
The license name as a string.
Deprecated:
There could be multiple licenses, use licenses() instead.

Definition at line 894 of file kaboutdata.cpp.

QList< KAboutLicense > KAboutData::licenses ( ) const

Returns a list of licenses.

Returns
licenses information (list of licenses)
Since
4.1

Definition at line 899 of file kaboutdata.cpp.

QString KAboutData::ocsProviderUrl ( ) const

Returns the chosen Open Collaboration Services provider URL.

Returns
the provider URL.

Definition at line 738 of file kaboutdata.cpp.

KAboutData & KAboutData::operator= ( const KAboutData &  other)

Assignment operator.

Performs a deep copy.

Parameters
otherobject to copy

Definition at line 491 of file kaboutdata.cpp.

QString KAboutData::organizationDomain ( ) const

Returns the domain name of the organization that wrote this application.

Used by the automatic registration to D-Bus done by KApplication and KUniqueApplication.

Definition at line 783 of file kaboutdata.cpp.

QString KAboutData::otherText ( ) const

Returns a translated, free form text.

Returns
the free form text (translated). Can be QString() if not set.

Definition at line 882 of file kaboutdata.cpp.

QString KAboutData::productName ( ) const

Returns the application's product name, which will be used in KBugReport dialog.

By default it returns appName(), otherwise the one which is set with setProductName()

Returns
the product name.

Definition at line 683 of file kaboutdata.cpp.

QString KAboutData::programIconName ( ) const

Returns the program's icon name.

The default value is appName(). Use setProgramIconName() if you need to have an icon whose name is different from the internal application name.

Returns
the program's icon name.
See also
setProgramIconName()
Since
4.1

Definition at line 716 of file kaboutdata.cpp.

QVariant KAboutData::programLogo ( ) const

Returns the program logo image.

Because KAboutData is in kdecore it cannot use QImage directly, so this is a QVariant containing a QImage.

Returns
the program logo data, or a null image if there is no custom application logo defined.

Definition at line 727 of file kaboutdata.cpp.

QString KAboutData::programName ( ) const

Returns the translated program name.

Returns
the program name (translated).

Definition at line 690 of file kaboutdata.cpp.

KAboutData & KAboutData::setAppName ( const QByteArray &  appName)

Defines the program name used internally.

Parameters
appNameThe application name. Example: "kate".

Definition at line 587 of file kaboutdata.cpp.

KAboutData & KAboutData::setBugAddress ( const QByteArray &  bugAddress)

Defines the address where bug reports should be sent.

Parameters
bugAddressThe bug report email address string. This defaults to the kde.org bug system.

Definition at line 660 of file kaboutdata.cpp.

KAboutData & KAboutData::setCatalogName ( const QByteArray &  catalogName)

Defines the translation catalog that the program uses.

Parameters
catalogNameThe translation catalog name.

Definition at line 618 of file kaboutdata.cpp.

KAboutData & KAboutData::setCopyrightStatement ( const KLocalizedString &  copyrightStatement)

Defines the copyright statement to show when displaying the license.

Parameters
copyrightStatementA copyright statement, that can look like this: ki18n("Copyright (C) 1999-2000 Name"). The string specified here is taken verbatim; the author information from addAuthor is not used.

Definition at line 642 of file kaboutdata.cpp.

KAboutData & KAboutData::setCustomAuthorText ( const KLocalizedString &  plainText,
const KLocalizedString &  richText 
)

Sets the custom text displayed around the list of authors instead of the default message telling users to send bug reports to bugAddress().

Parameters
plainTextThe plain text.
richTextThe rich text.

Setting both to parameters to KLocalizedString() will cause no message to be displayed at all. Call unsetCustomAuthorText() to revert to the default message.

Definition at line 930 of file kaboutdata.cpp.

KAboutData & KAboutData::setHomepage ( const QByteArray &  homepage)

Defines the program homepage.

Parameters
homepageThe program homepage string. Start the address with "http://". "http://kate.kde.org" is correct but "kate.kde.org" is not.

Definition at line 654 of file kaboutdata.cpp.

KAboutData & KAboutData::setLicense ( LicenseKey  licenseKey)

Defines the license identifier.

Parameters
licenseKeyThe license identifier.
See also
addLicenseText, setLicenseText, setLicenseTextFile

Definition at line 624 of file kaboutdata.cpp.

KAboutData & KAboutData::setLicenseText ( const KLocalizedString &  license)

Defines a license text, which is marked for translation.

Example:

setLicenseText( ki18n("This is my license") );
Parameters
licenseThe license text.

Definition at line 551 of file kaboutdata.cpp.

KAboutData & KAboutData::setLicenseTextFile ( const QString &  file)

Defines a license text by pointing to a file where it resides.

The file format has to be plain text in an encoding compatible to the locale.

Parameters
filePath to the file in the local filesystem containing the license text.

Definition at line 569 of file kaboutdata.cpp.

KAboutData & KAboutData::setOcsProvider ( const QByteArray &  providerUrl)

Specifies an Open Collaboration Services provider by URL.

A provider file must be available for the chosen provider.

Use this if you need to override the default provider.

If this method is not used, all the KAboutPerson OCS usernames will be used with the openDesktop.org entry from the default provider file.

Parameters
providerUrlThe provider URL as defined in the provider file.

Definition at line 600 of file kaboutdata.cpp.

KAboutData & KAboutData::setOrganizationDomain ( const QByteArray &  domain)

Defines the Internet domain of the organization that wrote this application.

The domain is set to kde.org by default, or the domain of the homePageAddress constructor argument, if set.

Make sure to call setOrganizationDomain if your product is developed out of the kde.org version-control system.

Used by the automatic registration to D-Bus done by KApplication and KUniqueApplication.

IMPORTANT: if the organization domain is set, the .desktop file that describes your application should have an entry like X-DBUS-ServiceName=reversed_domain.kmyapp For instance kwrite passes "http://www.kate-editor.org" as the homePageAddress so it needs X-DBUS-ServiceName=org.kate-editor.kwrite in its kwrite.desktop file.

Parameters
domainthe domain name, for instance kde.org, koffice.org, kdevelop.org, etc.

Definition at line 666 of file kaboutdata.cpp.

KAboutData & KAboutData::setOtherText ( const KLocalizedString &  otherText)

Defines the additional text to show in the about dialog.

Parameters
otherTextSome free form text, that can contain any kind of information. The text can contain newlines. This string should be marked for translation.

Definition at line 648 of file kaboutdata.cpp.

KAboutData & KAboutData::setProductName ( const QByteArray &  name)

Defines the product name which will be used in the KBugReport dialog.

By default it's the appName, but you can overwrite it here to provide support for special components e.g. in the form 'product/component', such as 'kontact/summary'.

Parameters
nameThe name of product

Definition at line 672 of file kaboutdata.cpp.

KAboutData & KAboutData::setProgramIconName ( const QString &  iconName)

Defines the program icon.

Use this if you need to have an application icon whose name is different than the application name.

Parameters
iconNamename of the icon. Example: "accessories-text-editor"
See also
programIconName()
Since
4.1

Definition at line 721 of file kaboutdata.cpp.

KAboutData & KAboutData::setProgramLogo ( const QVariant &  image)

Defines the program logo.

Use this if you need to have an application logo in AboutData other than the application icon.

Because KAboutData is in kdecore it cannot use QImage directly, so this is a QVariant that should contain a QImage.

Parameters
imagelogo image.
See also
programLogo()

Definition at line 732 of file kaboutdata.cpp.

KAboutData & KAboutData::setProgramName ( const KLocalizedString &  programName)

Defines the displayable program name string.

Parameters
programNameThe program name. This string should be marked for translation. Example: ki18n("Advanced Text Editor").

Definition at line 593 of file kaboutdata.cpp.

KAboutData & KAboutData::setShortDescription ( const KLocalizedString &  shortDescription)

Defines a short description of what the program does.

Parameters
shortDescriptionThe program description. This string should be marked for translation. Example: ki18n("An advanced text editor with syntax highlighting support.").

Definition at line 612 of file kaboutdata.cpp.

KAboutData & KAboutData::setTranslator ( const KLocalizedString &  name,
const KLocalizedString &  emailAddress 
)

Sets the name(s) of the translator(s) of the GUI.

Since this depends on the language, just use a dummy text marked for translation.

The canonical use is:

setTranslator(ki18nc("NAME OF TRANSLATORS", "Your names"),
ki18nc("EMAIL OF TRANSLATORS", "Your emails"));

The translator can then translate this dummy text with his name or with a list of names separated with ",". If there is no translation or the application is used with the default language, this function call is ignored.

Parameters
namethe name(s) of the translator(s)
emailAddressthe email address(es) of the translator(s)
See also
KAboutTranslator

Definition at line 543 of file kaboutdata.cpp.

KAboutData & KAboutData::setVersion ( const QByteArray &  version)

Defines the program version string.

Parameters
versionThe program version.

Definition at line 606 of file kaboutdata.cpp.

QString KAboutData::shortDescription ( ) const

Returns a short, translated description.

Returns
the short description (translated). Can be QString() if not set.

Definition at line 758 of file kaboutdata.cpp.

void KAboutData::translateInternalProgramName ( ) const

Provided for use by KCrash

KCrash should call as few things as possible and should avoid e.g. malloc() because it may deadlock. Since i18n() needs it, when KLocale is available the i18n() call will be done here in advance.

Definition at line 709 of file kaboutdata.cpp.

QList< KAboutPerson > KAboutData::translators ( ) const

Returns a list of translators.

Returns
translators information (list of persons)

Definition at line 811 of file kaboutdata.cpp.

KAboutData & KAboutData::unsetCustomAuthorText ( )

Clears any custom text displayed around the list of authors and falls back to the default message telling users to send bug reports to bugAddress().

Definition at line 941 of file kaboutdata.cpp.

QString KAboutData::version ( ) const

Returns the program's version.

Returns
the version string.

Definition at line 745 of file kaboutdata.cpp.


The documentation for this class was generated from the following files:
  • kaboutdata.h
  • kaboutdata.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:22:12 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

Skip menu "KDECore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal