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>
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 | |
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") | |
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) |
void | setTranslator (const char *name, const char *emailAddress) |
void | setLicenseText (const char *license) |
void | setLicenseTextFile (const QString &file) |
void | setProductName (const char *name) |
const char * | appName () const |
const char * | productName () const |
QString | programName () const |
QString | version () const |
QString | shortDescription () const |
QString | homepage () const |
QString | bugAddress () const |
const QValueList< KAboutPerson > | authors () const |
const QValueList< KAboutPerson > | credits () const |
const QValueList< KAboutTranslator > | translators () const |
QString | otherText () const |
QString | license () const |
QString | copyrightStatement () const |
Static Public Member Functions | |
QString | aboutTranslationTeam () |
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.35 2003/11/24 22:19:37 tokoe Exp
Definition at line 168 of file kaboutdata.h.
Member Enumeration Documentation
|
Descibes the license of the software.
Definition at line 174 of file kaboutdata.h. |
Constructor & Destructor Documentation
|
Constructor.
Definition at line 88 of file kaboutdata.cpp. References KAboutData(). Referenced by KAboutData(). |
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 126 of file kaboutdata.cpp. References addAuthor(), and QValueList< KAboutPerson >::append(). Referenced by addAuthor(). |
|
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 133 of file kaboutdata.cpp. References addCredit(), and QValueList< KAboutPerson >::append(). Referenced by addCredit(). |
|
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:
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.
Definition at line 140 of file kaboutdata.cpp. References setTranslator(). Referenced by setTranslator(). |
|
Defines a license text. The text will be translated if it got marked for translations with the I18N_NOOP() macro. Example:
NOTE: No copy of the text is made.
Definition at line 147 of file kaboutdata.cpp. References setLicenseText(). Referenced by setLicenseText(). |
|
Defines a license text.
Definition at line 154 of file kaboutdata.cpp. References setLicenseTextFile(). Referenced by setLicenseTextFile(). |
|
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'.
Definition at line 161 of file kaboutdata.cpp. References setProductName(). Referenced by setProductName(). |
|
Returns the application's internal name.
Definition at line 167 of file kaboutdata.cpp. Referenced by KCmdLineArgs::init(), productName(), and KUniqueApplication::start(). |
|
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()
Definition at line 173 of file kaboutdata.cpp. References appName(). |
|
Returns the translated program name.
Definition at line 182 of file kaboutdata.cpp. Referenced by KApplication::caption(), and KCrash::defaultCrashHandler(). |
|
Returns the program's version.
Definition at line 191 of file kaboutdata.cpp. Referenced by KCrash::defaultCrashHandler(). |
|
Returns a short, translated description.
Definition at line 197 of file kaboutdata.cpp. Referenced by KCmdLineArgs::usage(). |
|
Returns the application homepage.
Definition at line 206 of file kaboutdata.cpp. |
|
Returns the email address for bugs.
Definition at line 212 of file kaboutdata.cpp. Referenced by KCrash::defaultCrashHandler(). |
|
Returns a list of authors.
Definition at line 218 of file kaboutdata.cpp. |
|
Returns a list of persons who contributed.
Definition at line 224 of file kaboutdata.cpp. |
|
Returns a list of translators.
Definition at line 230 of file kaboutdata.cpp. References QValueList::append(). |
|
Returns a message about the translation team.
Definition at line 279 of file kaboutdata.cpp. |
|
Returns a translated, free form text.
Definition at line 289 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 299 of file kaboutdata.cpp. References QString::arg(), copyrightStatement(), QString::isEmpty(), QFile::open(), and QTextStream::read(). |
|
Returns the copyright statement.
Definition at line 359 of file kaboutdata.cpp. Referenced by license(). |
The documentation for this class was generated from the following files: