K4AboutData

#include <k4aboutdata.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
	K4AboutData (const K4AboutData &other)

	K4AboutData (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="[email protected]")

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

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

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

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

K4AboutData &	addLicense (LicenseKey licenseKey)

K4AboutData &	addLicenseText (const KLocalizedString &license)

K4AboutData &	addLicenseTextFile (const QString &file)

QString	appName () const

QList< K4AboutPerson >	authors () const

QString	bugAddress () const

QString	catalogName () const

QString	copyrightStatement () const

QList< K4AboutPerson >	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< K4AboutLicense >	licenses () const

QString	ocsProviderUrl () const

	operator KAboutData () const

K4AboutData &	operator= (const K4AboutData &other)

QString	organizationDomain () const

QString	otherText () const

QString	productName () const

QString	programIconName () const

QVariant	programLogo () const

QString	programName () const

K4AboutData &	setAppName (const QByteArray &appName)

K4AboutData &	setBugAddress (const QByteArray &bugAddress)

K4AboutData &	setCatalogName (const QByteArray &catalogName)

K4AboutData &	setCopyrightStatement (const KLocalizedString &copyrightStatement)

K4AboutData &	setCustomAuthorText (const KLocalizedString &plainText, const KLocalizedString &richText)

K4AboutData &	setHomepage (const QByteArray &homepage)

K4AboutData &	setLicense (LicenseKey licenseKey)

K4AboutData &	setLicenseText (const KLocalizedString &license)

K4AboutData &	setLicenseTextFile (const QString &file)

K4AboutData &	setOcsProvider (const QByteArray &providerUrl)

K4AboutData &	setOrganizationDomain (const QByteArray &domain)

K4AboutData &	setOtherText (const KLocalizedString &otherText)

K4AboutData &	setProductName (const QByteArray &name)

K4AboutData &	setProgramIconName (const QString &iconName)

K4AboutData &	setProgramLogo (const QVariant &image)

K4AboutData &	setProgramName (const KLocalizedString &programName)

K4AboutData &	setShortDescription (const KLocalizedString &shortDescription)

K4AboutData &	setTranslator (const KLocalizedString &name, const KLocalizedString &emailAddress)

K4AboutData &	setVersion (const QByteArray &version)

QString	shortDescription () const

void	translateInternalProgramName () const

QList< K4AboutPerson >	translators () const

K4AboutData &	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 K4AboutPerson), license and copyright information.

Currently, the values set here are shown by the "About" box (see K4AboutDialog), 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 K4AboutData is constructed.

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

Author: Espen Sand (espen[email protected]@kde[email protected].org), David Faure (faure[email protected]@kde[email protected].org)

Definition at line 199 of file k4aboutdata.h.

Member Enumeration Documentation

◆ LicenseKey

enum K4AboutData::LicenseKey

Describes the license of the software.

Definition at line 205 of file k4aboutdata.h.

◆ NameFormat

enum K4AboutData::NameFormat

Format of the license name.

Definition at line 224 of file k4aboutdata.h.

Constructor & Destructor Documentation

◆ K4AboutData() [1/2]

K4AboutData::K4AboutData	(	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 = `"[email protected]"`
	)

Constructor.

Parameters

appName	The program name used internally. Example: "kedit"
catalogName	The 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.
programName	A displayable program name string. This string should be marked for translation. Example: ki18n("KEdit")
version	The program version string.
shortDescription	A short description of what the program does. This string should be marked for translation. Example: ki18n("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: ki18n("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 marked for translation.
homePageAddress	The 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

bugsEmailAddress The bug report email address string. This defaults to the kde.org bug system.

Definition at line 419 of file k4aboutdata.cpp.

◆ K4AboutData() [2/2]

K4AboutData::K4AboutData ( const K4AboutData & other )

Copy constructor.

Performs a deep copy.

Parameters

other object to copy

Definition at line 472 of file k4aboutdata.cpp.

Member Function Documentation

◆ aboutTranslationTeam()

QString K4AboutData::aboutTranslationTeam ( )

static

Returns a message about the translation team.

Returns: a message about the translation team

Definition at line 888 of file k4aboutdata.cpp.

◆ addAuthor() [1/2]

K4AboutData & K4AboutData::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

name	The developer's name. It should be marked for translation like this: ki18n("Developer Name")
task	What 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.
emailAddress	An Email address where the person can be reached. Can be left empty.
webAddress	The 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.
ocsUsername	The person's Open Collaboration Services username. The provider can be optionally specified with

See also: setOcsProvider.

Definition at line 524 of file k4aboutdata.cpp.

◆ addAuthor() [2/2]

K4AboutData & K4AboutData::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

name	The developer's name. It should be marked for translation like this: ki18n("Developer Name")
task	What 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.
emailAddress	An Email address where the person can be reached. Can be left empty.
webAddress	The 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 515 of file k4aboutdata.cpp.

◆ addCredit() [1/2]

K4AboutData & K4AboutData::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

name	The person's name. It should be marked for translation like this: ki18n("Contributor Name")
task	What 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.
emailAddress	An email address when the person can be reached. Can be left empty.
webAddress	The 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.
ocsUsername	The person's Open Collaboration Services username. The provider can be optionally specified with

See also: setOcsProvider.

Definition at line 543 of file k4aboutdata.cpp.

◆ addCredit() [2/2]

K4AboutData & K4AboutData::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

name	The person's name. It should be marked for translation like this: ki18n("Contributor Name")
task	What 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.
emailAddress	An email address when the person can be reached. Can be left empty.
webAddress	The 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 534 of file k4aboutdata.cpp.

◆ addLicense()

K4AboutData & K4AboutData::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

licenseKey The license identifier.

See also: setLicenseText, addLicenseText, addLicenseTextFile

Since: 4.1

Definition at line 640 of file k4aboutdata.cpp.

◆ addLicenseText()

K4AboutData & K4AboutData::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

license The license text.

See also: setLicenseText, addLicense, addLicenseTextFile

Since: 4.1

Definition at line 567 of file k4aboutdata.cpp.

◆ addLicenseTextFile()

K4AboutData & K4AboutData::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

file	Path to the file in the local filesystem containing the license text.

See also: addLicenseText, addLicense, setLicenseTextFile

Since: 4.1

Definition at line 585 of file k4aboutdata.cpp.

◆ appName()

QString K4AboutData::appName ( ) const

Returns the application's internal name.

Returns: the internal program name.

Definition at line 688 of file k4aboutdata.cpp.

◆ authors()

QList< K4AboutPerson > K4AboutData::authors ( ) const

Returns a list of authors.

Returns: author information (list of persons).

Definition at line 818 of file k4aboutdata.cpp.

◆ bugAddress()

QString K4AboutData::bugAddress ( ) const

Returns the email address for bugs.

Returns: the email address where to report bugs.

Definition at line 797 of file k4aboutdata.cpp.

◆ catalogName()

QString K4AboutData::catalogName ( ) const

Returns the program's translation catalog name.

Returns: the catalog name.

Definition at line 783 of file k4aboutdata.cpp.

◆ copyrightStatement()

QString K4AboutData::copyrightStatement ( ) const

Returns the copyright statement.

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

Definition at line 921 of file k4aboutdata.cpp.

◆ credits()

QList< K4AboutPerson > K4AboutData::credits ( ) const

Returns a list of persons who contributed.

Returns: credit information (list of persons).

Definition at line 823 of file k4aboutdata.cpp.

◆ customAuthorPlainText()

QString K4AboutData::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 929 of file k4aboutdata.cpp.

◆ customAuthorRichText()

QString K4AboutData::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 937 of file k4aboutdata.cpp.

◆ customAuthorTextEnabled()

bool K4AboutData::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 945 of file k4aboutdata.cpp.

◆ homepage()

QString K4AboutData::homepage ( ) const

Returns the application homepage.

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

Definition at line 792 of file k4aboutdata.cpp.

◆ internalBugAddress()

const char * K4AboutData::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 810 of file k4aboutdata.cpp.

◆ internalProgramName()

const char * K4AboutData::internalProgramName ( ) const

Provided for use by KCrash

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

Definition at line 712 of file k4aboutdata.cpp.

◆ internalVersion()

const char * K4AboutData::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 770 of file k4aboutdata.cpp.

◆ license()

QString K4AboutData::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 906 of file k4aboutdata.cpp.

◆ licenseName()

QString K4AboutData::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 911 of file k4aboutdata.cpp.

◆ licenses()

QList< K4AboutLicense > K4AboutData::licenses ( ) const

Returns a list of licenses.

Returns: licenses information (list of licenses)

Since: 4.1

Definition at line 916 of file k4aboutdata.cpp.

◆ ocsProviderUrl()

QString K4AboutData::ocsProviderUrl ( ) const

Returns the chosen Open Collaboration Services provider URL.

Returns: the provider URL.

Definition at line 754 of file k4aboutdata.cpp.

◆ operator=()

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

Assignment operator.

Performs a deep copy.

Parameters

other object to copy

Definition at line 483 of file k4aboutdata.cpp.

◆ organizationDomain()

QString K4AboutData::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 802 of file k4aboutdata.cpp.

◆ otherText()

QString K4AboutData::otherText ( ) const

Returns a translated, free form text.

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

Definition at line 898 of file k4aboutdata.cpp.

◆ productName()

QString K4AboutData::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 693 of file k4aboutdata.cpp.

◆ programIconName()

QString K4AboutData::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 732 of file k4aboutdata.cpp.

◆ programLogo()

QVariant K4AboutData::programLogo ( ) const

Returns the program logo image.

Because K4AboutData 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 743 of file k4aboutdata.cpp.

◆ programName()

QString K4AboutData::programName ( ) const

Returns the translated program name.

Returns: the program name (translated).

Definition at line 701 of file k4aboutdata.cpp.

◆ setAppName()

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

Defines the program name used internally.

Parameters

appName The application name. Example: "kate".

Definition at line 597 of file k4aboutdata.cpp.

◆ setBugAddress()

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

Defines the address where bug reports should be sent.

Parameters

bugAddress The bug report email address string. This defaults to the kde.org bug system.

Definition at line 670 of file k4aboutdata.cpp.

◆ setCatalogName()

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

Defines the translation catalog that the program uses.

Parameters

catalogName The translation catalog name.

Definition at line 628 of file k4aboutdata.cpp.

◆ setCopyrightStatement()

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

Defines the copyright statement to show when displaying the license.

Parameters

copyrightStatement A 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 652 of file k4aboutdata.cpp.

◆ setCustomAuthorText()

K4AboutData & K4AboutData::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

plainText	The plain text.
richText	The 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 950 of file k4aboutdata.cpp.

◆ setHomepage()

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

Defines the program homepage.

Parameters

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

Definition at line 664 of file k4aboutdata.cpp.

◆ setLicense()

K4AboutData & K4AboutData::setLicense ( LicenseKey licenseKey )

Defines the license identifier.

Parameters

licenseKey The license identifier.

See also: addLicenseText, setLicenseText, setLicenseTextFile

Definition at line 634 of file k4aboutdata.cpp.

◆ setLicenseText()

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

Defines a license text, which is marked for translation.

Example:

setLicenseText( ki18n("This is my license") );

Parameters

license The license text.

Definition at line 561 of file k4aboutdata.cpp.

◆ setLicenseTextFile()

K4AboutData & K4AboutData::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

file	Path to the file in the local filesystem containing the license text.

Definition at line 579 of file k4aboutdata.cpp.

◆ setOcsProvider()

K4AboutData & K4AboutData::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 K4AboutPerson OCS usernames will be used with the openDesktop.org entry from the default provider file.

Parameters

providerUrl The provider URL as defined in the provider file.

Definition at line 610 of file k4aboutdata.cpp.

◆ setOrganizationDomain()

K4AboutData & K4AboutData::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

domain the domain name, for instance kde.org, koffice.org, kdevelop.org, etc.

Definition at line 676 of file k4aboutdata.cpp.

◆ setOtherText()

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

Defines the additional text to show in the about dialog.

Parameters

otherText Some 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 658 of file k4aboutdata.cpp.

◆ setProductName()

K4AboutData & K4AboutData::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

name	The name of product

Definition at line 682 of file k4aboutdata.cpp.

◆ setProgramIconName()

K4AboutData & K4AboutData::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

iconName name of the icon. Example: "accessories-text-editor"

See also: programIconName()

Since: 4.1

Definition at line 737 of file k4aboutdata.cpp.

◆ setProgramLogo()

K4AboutData & K4AboutData::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 K4AboutData is in kdecore it cannot use QImage directly, so this is a QVariant that should contain a QImage.

Parameters

image logo image.

See also: programLogo()

Definition at line 748 of file k4aboutdata.cpp.

◆ setProgramName()

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

Defines the displayable program name string.

Parameters

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

Definition at line 603 of file k4aboutdata.cpp.

◆ setShortDescription()

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

Defines a short description of what the program does.

Parameters

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

Definition at line 622 of file k4aboutdata.cpp.

◆ setTranslator()

K4AboutData & K4AboutData::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

name	the name(s) of the translator(s)
emailAddress	the email address(es) of the translator(s)

See also: K4AboutTranslator

Definition at line 553 of file k4aboutdata.cpp.

◆ setVersion()

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

Defines the program version string.

Parameters

version The program version.

Definition at line 616 of file k4aboutdata.cpp.

◆ shortDescription()

QString K4AboutData::shortDescription ( ) const

Returns a short, translated description.

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

Definition at line 775 of file k4aboutdata.cpp.

◆ translateInternalProgramName()

void K4AboutData::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 721 of file k4aboutdata.cpp.

◆ translators()

QList< K4AboutPerson > K4AboutData::translators ( ) const

Returns a list of translators.

Returns: translators information (list of persons)

Definition at line 830 of file k4aboutdata.cpp.

◆ unsetCustomAuthorText()

K4AboutData & K4AboutData::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 961 of file k4aboutdata.cpp.

◆ version()

QString K4AboutData::version ( ) const

Returns the program's version.

Returns: the version string.

Definition at line 762 of file k4aboutdata.cpp.

The documentation for this class was generated from the following files:

ki18nc

KLocalizedString KI18N_EXPORT ki18nc(const char *context, const char *text)

K4AboutData::setTranslator

K4AboutData & setTranslator(const KLocalizedString &name, const KLocalizedString &emailAddress)

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

Definition: k4aboutdata.cpp:553

K4AboutData::setLicenseText

K4AboutData & setLicenseText(const KLocalizedString &license)

Defines a license text, which is marked for translation.

Definition: k4aboutdata.cpp:561

ki18n

KLocalizedString KI18N_EXPORT ki18n(const char *text)

K4AboutData::addLicenseText

K4AboutData & addLicenseText(const KLocalizedString &license)

Adds a license text, which is marked for translation.

Definition: k4aboutdata.cpp:567

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KDELibs4Support

K4AboutData

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ LicenseKey

◆ NameFormat

Constructor & Destructor Documentation

◆ K4AboutData() [1/2]

◆ K4AboutData() [2/2]

Member Function Documentation

◆ aboutTranslationTeam()

◆ addAuthor() [1/2]

◆ addAuthor() [2/2]

◆ addCredit() [1/2]

◆ addCredit() [2/2]

◆ addLicense()

◆ addLicenseText()

◆ addLicenseTextFile()

◆ appName()

◆ authors()

◆ bugAddress()

◆ catalogName()

◆ copyrightStatement()

◆ credits()

◆ customAuthorPlainText()

◆ customAuthorRichText()

◆ customAuthorTextEnabled()

◆ homepage()

◆ internalBugAddress()

◆ internalProgramName()

◆ internalVersion()

◆ license()

◆ licenseName()

◆ licenses()

◆ ocsProviderUrl()

◆ operator=()

◆ organizationDomain()

◆ otherText()

◆ productName()

◆ programIconName()

◆ programLogo()

◆ programName()

◆ setAppName()

◆ setBugAddress()

◆ setCatalogName()

◆ setCopyrightStatement()

◆ setCustomAuthorText()

◆ setHomepage()

◆ setLicense()

◆ setLicenseText()

◆ setLicenseTextFile()

◆ setOcsProvider()

◆ setOrganizationDomain()

◆ setOtherText()

◆ setProductName()

◆ setProgramIconName()

◆ setProgramLogo()

◆ setProgramName()

◆ setShortDescription()

◆ setTranslator()

◆ setVersion()

◆ shortDescription()

◆ translateInternalProgramName()

◆ translators()

◆ unsetCustomAuthorText()

◆ version()