KAboutData Class Reference

This class is used to store information about a program. More...

#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 }
Public Member Functions
void	addAuthor (const char name, const char task=0, const char emailAddress=0, const char webAddress=0)
void	addCredit (const char name, const char task=0, const char emailAddress=0, const char webAddress=0)
const char *	appName () const
const QValueList< KAboutPerson >	authors () const
QString	bugAddress () const
QString	copyrightStatement () const
const QValueList< 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
	KAboutData (const char appName, const char programName, const char version, const char shortDescription=0, int licenseType=License_Unknown, const char copyrightStatement=0, const char text=0, const char homePageAddress=0, const char bugsEmailAddress="submit@bugs.kde.org")
QString	license () const
QString	otherText () const
const char *	productName () const
QImage	programLogo () const
QString	programName () const
void	setAppName (const char *appName)
void	setBugAddress (const char *bugAddress)
void	setCopyrightStatement (const char *copyrightStatement)
void	setCustomAuthorText (const QString &plainText, const QString &richText)
void	setHomepage (const char *homepage)
void	setLicense (LicenseKey licenseKey)
void	setLicenseText (const char *license)
void	setLicenseTextFile (const QString &file)
void	setOtherText (const char *otherText)
void	setProductName (const char *name)
void	setProgramLogo (const QImage &image)
void	setProgramName (const char *programName)
void	setShortDescription (const char *shortDescription)
void	setTranslator (const char name, const char emailAddress)
void	setVersion (const char *version)
QString	shortDescription () const
void	translateInternalProgramName () const
const QValueList < KAboutTranslator >	translators () const
void	unsetCustomAuthorText ()
QString	version () const
	~KAboutData ()
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).

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

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

Definition at line 182 of file kaboutdata.h.

Member Enumeration Documentation

enum KAboutData::LicenseKey

Descibes 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

Definition at line 188 of file kaboutdata.h.

Constructor & Destructor Documentation

KAboutData::KAboutData	(	const char *	appName,
		const char *	programName,
		const char *	version,
		const char *	shortDescription = `0`,
		int	licenseType = `License_Unknown`,
		const char *	copyrightStatement = `0`,
		const char *	text = `0`,
		const char *	homePageAddress = `0`,
		const char *	bugsEmailAddress = `"submit@bugs.kde.org"`
	)

Constructor.

Parameters:

	appName	The program name used internally. Example: "kedit"
	programName	A displayable program name string. This string should be marked for translation. Example: I18N_NOOP("KEdit")
	version	The program version string.
	shortDescription	A short description of what the program does. This string should be marked for translation. Example: I18N_NOOP("A simple text editor.")
	licenseType	The license identifier. Use setLicenseText if you use a license not predefined here.
	copyrightStatement	A copyright statement, that can look like this: "(c) 1999-2000, Name". The string specified here is not modified in any manner. The author information from addAuthor is not used.
	text	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.
	bugsEmailAddress	The bug report email address string. This defaults to the kde.org bug system.

Definition at line 101 of file kaboutdata.cpp.

KAboutData::~KAboutData ( )

Definition at line 133 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 385 of file kaboutdata.cpp.

void KAboutData::addAuthor	(	const char *	name,
		const char *	task = `0`,
		const char *	emailAddress = `0`,
		const char *	webAddress = `0`
	)

Defines an author.

You can call this function as many times 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 in UTF-8 encoding.
	task	What the person is responsible for. This text can contain newlines. It should be marked for translation like this: I18N_NOOP("Task description..."). Can be 0.
	emailAddress	An Email address where the person can be reached. Can be 0.
	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 0.

Definition at line 141 of file kaboutdata.cpp.

void KAboutData::addCredit	(	const char *	name,
		const char *	task = `0`,
		const char *	emailAddress = `0`,
		const char *	webAddress = `0`
	)

Defines a person that deserves credit.

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

Parameters:

	name	The person's name in UTF-8 encoding.
	task	What the person has done to deserve the honor. The text can contain newlines. It should be marked for translation like this: I18N_NOOP("Task description...") Can be 0.
	emailAddress	An Email address when the person can be reached. Can be 0.
	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 0.

Definition at line 148 of file kaboutdata.cpp.

const char * KAboutData::appName ( ) const

Returns the application's internal name.

Returns:: the internal program name.

Definition at line 237 of file kaboutdata.cpp.

const QValueList< KAboutPerson > KAboutData::authors ( ) const

Returns a list of authors.

Returns:: author information (list of persons).

Definition at line 324 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 318 of file kaboutdata.cpp.

QString KAboutData::copyrightStatement ( ) const

Returns the copyright statement.

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

Definition at line 469 of file kaboutdata.cpp.

const QValueList< KAboutPerson > KAboutData::credits ( ) const

Returns a list of persons who contributed.

Returns:: credit information (list of persons).

Definition at line 330 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::null.

Definition at line 478 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::null.

Definition at line 484 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 490 of file kaboutdata.cpp.

QString KAboutData::homepage ( ) const

Returns the application homepage.

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

Definition at line 312 of file kaboutdata.cpp.

const char* KAboutData::internalBugAddress ( ) const [inline]

For internal use only.

Definition at line 518 of file kaboutdata.h.

const char * KAboutData::internalProgramName ( ) const

For internal use only.

Definition at line 261 of file kaboutdata.cpp.

const char* KAboutData::internalVersion ( ) const [inline]

For internal use only.

Definition at line 493 of file kaboutdata.h.

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.

Definition at line 406 of file kaboutdata.cpp.

QString KAboutData::otherText ( ) const

Returns a translated, free form text.

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

Definition at line 396 of file kaboutdata.cpp.

const char * 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 243 of file kaboutdata.cpp.

QImage KAboutData::programLogo ( ) const

Returns the program logo image.

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

Since:: 3.4

Definition at line 282 of file kaboutdata.cpp.

QString KAboutData::programName ( ) const

Returns the translated program name.

Returns:: the program name (translated).

Definition at line 252 of file kaboutdata.cpp.

void KAboutData::setAppName ( const char * appName )

Defines the program name used internally.

Parameters:

appName

The application name. Example: "kate".

Definition at line 176 of file kaboutdata.cpp.

void KAboutData::setBugAddress ( const char * 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 225 of file kaboutdata.cpp.

void KAboutData::setCopyrightStatement ( const char * copyrightStatement )

Defines the copyright statement to show when displaying the license.

Parameters:

copyrightStatement

Definition at line 207 of file kaboutdata.cpp.

void KAboutData::setCustomAuthorText	(	const QString &	plainText,
		const QString &	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.

Both parameters can be QString::null to not display any message at all. Call unsetCustomAuthorText() to revert to the default mesage.

Definition at line 496 of file kaboutdata.cpp.

void KAboutData::setHomepage ( const char * homepage )

Defines the program homepage.

Parameters:

homepage

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

Definition at line 219 of file kaboutdata.cpp.

void KAboutData::setLicense ( LicenseKey licenseKey )

Defines the license identifier.

Parameters:

licenseKey

The license identifier.

Definition at line 201 of file kaboutdata.cpp.

void KAboutData::setLicenseText ( const char * license )

Defines a license text.

The text will be translated if it got marked for translations with the I18N_NOOP() macro.

Example:

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

NOTE: No copy of the text is made.

Parameters:

license

The license text in utf8 encoding.

Definition at line 162 of file kaboutdata.cpp.

void KAboutData::setLicenseTextFile ( const QString & file )

Defines a license text.

Parameters:

file

File containing the license text.

Definition at line 169 of file kaboutdata.cpp.

void KAboutData::setOtherText ( const char * 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 213 of file kaboutdata.cpp.

void KAboutData::setProductName ( const char * name )

Defines the product name wich 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. 'product/component' like 'kontact/summary'.

Parameters:

name

The name of product

Definition at line 231 of file kaboutdata.cpp.

void KAboutData::setProgramLogo ( const QImage & image )

Defines the program logo.

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

Parameters:

image

logo image.

See also:: programLogo()

Since:: 3.4

Definition at line 288 of file kaboutdata.cpp.

void KAboutData::setProgramName ( const char * programName )

Defines the displayable program name string.

Parameters:

programName

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

Since:: 3.2

Definition at line 182 of file kaboutdata.cpp.

void KAboutData::setShortDescription ( const char * shortDescription )

Defines a short description of what the program does.

Parameters:

shortDescription

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

Definition at line 195 of file kaboutdata.cpp.

void KAboutData::setTranslator	(	const char *	name,
		const char *	emailAddress
	)

Sets the name of the translator of the gui.

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

For example:

 setTranslator(I18N_NOOP("_: NAME OF TRANSLATORS\\nYour names")
 ,I18N_NOOP("_: EMAIL OF TRANSLATORS\\nYour 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.

Note: If you are using the default KDE automake environment, there is no need to use this function, because the two default strings above are added to the applications po file automatically.

Parameters:

	name	the name of the translator
	emailAddress	the email address of the translator

See also:: KAboutTranslator

Definition at line 155 of file kaboutdata.cpp.

void KAboutData::setVersion ( const char * version )

Defines the program version string.

Parameters:

version

The program version.

Definition at line 189 of file kaboutdata.cpp.

QString KAboutData::shortDescription ( ) const

Returns a short, translated description.

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

Definition at line 303 of file kaboutdata.cpp.

void KAboutData::translateInternalProgramName ( ) const

For internal use only.

Definition at line 273 of file kaboutdata.cpp.

const QValueList< KAboutTranslator > KAboutData::translators ( ) const

Returns a list of translators.

Returns:: translators information (list of persons)

Definition at line 336 of file kaboutdata.cpp.

void 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 505 of file kaboutdata.cpp.

QString KAboutData::version ( ) const

Returns the program's version.

Returns:: the version string.

Definition at line 297 of file kaboutdata.cpp.

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

KDECore

KAboutData Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

KDECore

API Reference