KAboutData Class Reference
This class is used to store information about a program. Holds information needed by the "About" box and other classes. More...
#include <kaboutdata.h>
Collaboration diagram for KAboutData:

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 } |
Descibes the license of the software. More... | |
Public Member Functions | |
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. | |
void | addAuthor (const char *name, const char *task=0, const char *emailAddress=0, const char *webAddress=0) |
Defines an author. | |
void | addCredit (const char *name, const char *task=0, const char *emailAddress=0, const char *webAddress=0) |
Defines a person that deserves credit. | |
void | setTranslator (const char *name, const char *emailAddress) |
Sets the name of the translator of the gui. | |
void | setLicenseText (const char *license) |
Defines a licence text. | |
void | setLicenseTextFile (const QString &file) |
Defines a licence text. | |
const char * | appName () const |
Returns the application's internal name. | |
QString | programName () const |
Returns the translated program name. | |
QString | version () const |
Returns the program's version. | |
QString | shortDescription () const |
Returns a short, translated description. | |
QString | homepage () const |
Returns the application homepage. | |
QString | bugAddress () const |
Returns the email address for bugs. | |
const QValueList< KAboutPerson > | authors () const |
Returns a list of authors. | |
const QValueList< KAboutPerson > | credits () const |
Returns a list of persons who contributed. | |
const QValueList< KAboutTranslator > | translators () const |
Returns a list of translators. | |
QString | otherText () const |
Returns a translated, free form text. | |
QString | license () const |
Returns the license. | |
QString | copyrightStatement () const |
Returns the copyright statement. | |
Static Public Member Functions | |
QString | aboutTranslationTeam () |
Returns a message about the translation team. |
Detailed Description
This class is used to store information about a program. Holds information needed by the "About" box and other classes.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).
- Author:
- Espen Sand (espen@kde.org), David Faure (faure@kde.org)
- Version:
- Id
- kaboutdata.h,v 1.26.2.1 2003/04/25 18:14:50 waba Exp
Definition at line 167 of file kaboutdata.h.
Member Enumeration Documentation
|
Descibes the license of the software.
Definition at line 173 of file kaboutdata.h. |
Constructor & Destructor Documentation
|
Constructor.
Definition at line 87 of file kaboutdata.cpp. |
Member Function Documentation
|
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.
Definition at line 124 of file kaboutdata.cpp. References QValueList< KAboutPerson >::append(), and KStdAction::name(). |
|
Defines a person that deserves credit. You can call this function as many times you need. Each entry is appended to a list.
Definition at line 131 of file kaboutdata.cpp. References QValueList< KAboutPerson >::append(), and KStdAction::name(). |
|
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:
Definition at line 138 of file kaboutdata.cpp. References KStdAction::name(). |
|
Defines a licence text. The text will be translated if it got marked for translations with the I18N_NOOP() macro. Example:
Definition at line 145 of file kaboutdata.cpp. |
|
Defines a licence text.
Definition at line 152 of file kaboutdata.cpp. References QFile::encodeName(). |
|
Returns the application's internal name.
Definition at line 160 of file kaboutdata.cpp. Referenced by KUniqueApplication::start(). |
|
Returns the translated program name.
Definition at line 166 of file kaboutdata.cpp. Referenced by KApplication::caption(), and KCrash::defaultCrashHandler(). |
|
Returns the program's version.
Definition at line 175 of file kaboutdata.cpp. References QString::fromLatin1(). Referenced by KCrash::defaultCrashHandler(). |
|
Returns a short, translated description.
Definition at line 181 of file kaboutdata.cpp. Referenced by KCmdLineArgs::usage(). |
|
Returns the application homepage.
Definition at line 190 of file kaboutdata.cpp. References QString::fromLatin1(). |
|
Returns the email address for bugs.
Definition at line 196 of file kaboutdata.cpp. References QString::fromLatin1(). Referenced by KCrash::defaultCrashHandler(). |
|
Returns a list of authors.
Definition at line 202 of file kaboutdata.cpp. |
|
Returns a list of persons who contributed.
Definition at line 208 of file kaboutdata.cpp. |
|
Returns a list of translators.
Definition at line 214 of file kaboutdata.cpp. References QValueList::append(), QString::fromUtf8(), KStdAction::name(), and QStringList::split(). |
|
Returns a message about the translation team.
Definition at line 263 of file kaboutdata.cpp. |
|
Returns a translated, free form text.
Definition at line 273 of file kaboutdata.cpp. |
|
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.
Definition at line 283 of file kaboutdata.cpp. References QString::arg(), QFile::decodeName(), QString::isEmpty(), QFile::open(), and QTextStream::read(). |
|
Returns the copyright statement.
Definition at line 342 of file kaboutdata.cpp. |
The documentation for this class was generated from the following files: