KAboutData Class Reference
#include <kaboutdata.h>
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)
Definition at line 182 of file 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") | |
~KAboutData () | |
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 | setAppName (const char *appName) |
void | setProgramName (const char *programName) |
void | setProgramLogo (const QImage &image) |
void | setVersion (const char *version) |
void | setShortDescription (const char *shortDescription) |
void | setLicense (LicenseKey licenseKey) |
void | setCopyrightStatement (const char *copyrightStatement) |
void | setOtherText (const char *otherText) |
void | setHomepage (const char *homepage) |
void | setBugAddress (const char *bugAddress) |
void | setProductName (const char *name) |
const char * | appName () const |
const char * | productName () const |
QString | programName () const |
const char * | internalProgramName () const |
void | translateInternalProgramName () const |
QImage | programLogo () const |
QString | version () const |
const char * | internalVersion () const |
QString | shortDescription () const |
QString | homepage () const |
QString | bugAddress () const |
const char * | internalBugAddress () 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 |
QString | customAuthorPlainText () const |
QString | customAuthorRichText () const |
bool | customAuthorTextEnabled () const |
void | setCustomAuthorText (const QString &plainText, const QString &richText) |
void | unsetCustomAuthorText () |
Static Public Member Functions | |
static QString | aboutTranslationTeam () |
Member Enumeration Documentation
|
Descibes the license of the software.
Definition at line 188 of file kaboutdata.h. |
Constructor & Destructor Documentation
|
Constructor.
Definition at line 101 of file kaboutdata.cpp. |
Member Function Documentation
|
Returns a message about the translation team.
Definition at line 385 of file kaboutdata.cpp. |
|
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 141 of file kaboutdata.cpp. |
|
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 148 of file kaboutdata.cpp. |
|
Returns the application's internal name.
Definition at line 237 of file kaboutdata.cpp. |
|
Returns a list of authors.
Definition at line 324 of file kaboutdata.cpp. |
|
Returns the email address for bugs.
Definition at line 318 of file kaboutdata.cpp. |
|
Returns the copyright statement.
Definition at line 468 of file kaboutdata.cpp. |
|
Returns a list of persons who contributed.
Definition at line 330 of file kaboutdata.cpp. |
|
Returns the plain text displayed around the list of authors instead of the default message telling users to send bug reports to bugAddress().
Definition at line 477 of file kaboutdata.cpp. |
|
Returns the rich text displayed around the list of authors instead of the default message telling users to send bug reports to bugAddress().
Definition at line 483 of file kaboutdata.cpp. |
|
Returns whether custom text should be displayed around the list of authors.
Definition at line 489 of file kaboutdata.cpp. |
|
Returns the application homepage.
Definition at line 312 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 405 of file kaboutdata.cpp. |
|
Returns a translated, free form text.
Definition at line 395 of file kaboutdata.cpp. |
|
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 243 of file kaboutdata.cpp. |
|
Returns the program logo image.
Definition at line 282 of file kaboutdata.cpp. |
|
Returns the translated program name.
Definition at line 252 of file kaboutdata.cpp. |
|
Defines the program name used internally.
Definition at line 176 of file kaboutdata.cpp. |
|
Defines the address where bug reports should be sent.
Definition at line 225 of file kaboutdata.cpp. |
|
Defines the copyright statement to show when displaying the license.
Definition at line 207 of file kaboutdata.cpp. |
|
Sets the custom text displayed around the list of authors instead of the default message telling users to send bug reports to bugAddress().
Definition at line 495 of file kaboutdata.cpp. |
|
Defines the program homepage.
Definition at line 219 of file kaboutdata.cpp. |
|
Defines the license identifier.
Definition at line 201 of file kaboutdata.cpp. |
|
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.
Definition at line 162 of file kaboutdata.cpp. |
|
Defines a license text.
Definition at line 169 of file kaboutdata.cpp. |
|
Defines the additional text to show in the about dialog.
Definition at line 213 of file kaboutdata.cpp. |
|
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 231 of file kaboutdata.cpp. |
|
Defines the program logo. Use this if you need to have application logo in AboutData other than application icon.
Definition at line 288 of file kaboutdata.cpp. |
|
Defines the displayable program name string.
Definition at line 182 of file kaboutdata.cpp. |
|
Defines a short description of what the program does.
Definition at line 195 of file kaboutdata.cpp. |
|
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.
Definition at line 155 of file kaboutdata.cpp. |
|
Defines the program version string.
Definition at line 189 of file kaboutdata.cpp. |
|
Returns a short, translated description.
Definition at line 303 of file kaboutdata.cpp. |
|
Returns a list of translators.
Definition at line 336 of file kaboutdata.cpp. |
|
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 504 of file kaboutdata.cpp. |
|
Returns the program's version.
Definition at line 297 of file kaboutdata.cpp. |
The documentation for this class was generated from the following files: