class KAboutData

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

Definition#include <kaboutdata.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods


Detailed Description

This class is used to store information about a program. It can store such values a version number, program name, homepage, 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 KCmdLineArguments).

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 }

 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:

void  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:

void  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:

void  setLicenseText ( const char *license )

Defines a licence text.

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

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

NOTE: No copy of the text is made.

Parameters:

void  setLicenseTextFile ( const QString &file )

Defines a licence text.

Parameters:

const char * appName ()

[const]

Returns: the internal program name.

QString  programName ()

[const]

Returns: the program name (translated).

QString  version ()

[const]

Returns: the version string.

QString  shortDescription ()

[const]

Returns: the short description (translated).

QString  homepage ()

[const]

Returns: the application homepage URL.

QString  bugAddress ()

[const]

Returns: the email address where to report bugs.

const QValueList<KAboutPerson>  authors ()

[const]

Returns: author information (list of persons).

const QValueList<KAboutPerson>  credits ()

[const]

Returns: credit information (list of persons).

QString  otherText ()

[const]

Returns: the free form text (translated).

QString  license ()

[const]

Returns the license. If setLicenseType 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.

QString  copyrightStatement ()

[const]

Returns: the copyright statement.