org.kde.koala
public class KAboutData extends Object implements QtSupport
UNKNOWN: Holds information needed by the "About" box and other classes.
Field Summary | |
---|---|
static int | License_Artistic |
static int | License_BSD |
static int | License_Custom
Descibes the license of the software. |
static int | License_File |
static int | License_GPL |
static int | License_GPL_V2 |
static int | License_LGPL |
static int | License_LGPL_V2 |
static int | License_QPL |
static int | License_QPL_V1_0 |
static int | License_Unknown |
Constructor Summary | |
---|---|
protected | KAboutData(Class dummy) |
KAboutData(String appName, String programName, String version, String shortDescription, int licenseType, String copyrightStatement, String text, String homePageAddress, String bugsEmailAddress)
Constructor. | |
KAboutData(String appName, String programName, String version, String shortDescription, int licenseType, String copyrightStatement, String text, String homePageAddress) | |
KAboutData(String appName, String programName, String version, String shortDescription, int licenseType, String copyrightStatement, String text) | |
KAboutData(String appName, String programName, String version, String shortDescription, int licenseType, String copyrightStatement) | |
KAboutData(String appName, String programName, String version, String shortDescription, int licenseType) | |
KAboutData(String appName, String programName, String version, String shortDescription) | |
KAboutData(String appName, String programName, String version) |
Method Summary | |
---|---|
static String | aboutTranslationTeam()
Returns a message about the translation team. |
void | addAuthor(String name, String task, String emailAddress, String webAddress)
Defines an author. |
void | addAuthor(String name, String task, String emailAddress) |
void | addAuthor(String name, String task) |
void | addAuthor(String name) |
void | addCredit(String name, String task, String emailAddress, String webAddress)
Defines a person that deserves credit. |
void | addCredit(String name, String task, String emailAddress) |
void | addCredit(String name, String task) |
void | addCredit(String name) |
String | appName()
Returns the application's internal name. |
String | bugAddress()
Returns the email address for bugs. |
String | copyrightStatement()
Returns the copyright statement. |
String | customAuthorPlainText()
Returns the plain text displayed around the list of authors instead
of the default message telling users to send bug reports to bugAddress(). |
String | customAuthorRichText()
Returns the rich text displayed around the list of authors instead
of the default message telling users to send bug reports to bugAddress(). |
boolean | customAuthorTextEnabled()
Returns whether custom text should be displayed around the list of
authors. |
void | dispose() Delete the wrapped C++ instance ahead of finalize() |
protected void | finalize() Deletes the wrapped C++ instance |
String | homepage()
Returns the application homepage. |
boolean | isDisposed() Has the wrapped C++ instance been deleted? |
String | license()
Returns the license. |
String | otherText()
Returns a translated, free form text. |
String | productName()
Returns the application's product name, which will be used in KBugReport
dialog. |
QImage | programLogo()
Returns the program logo image. |
String | programName()
Returns the translated program name. |
void | setAppName(String appName)
Defines the program name used internally. |
void | setBugAddress(String bugAddress)
Defines the address where bug reports should be sent. |
void | setCopyrightStatement(String copyrightStatement)
Defines the copyright statement to show when displaying the license. |
void | setCustomAuthorText(String plainText, String richText)
Sets the custom text displayed around the list of authors instead
of the default message telling users to send bug reports to bugAddress(). |
void | setHomepage(String homepage)
Defines the program homepage. |
void | setLicense(int licenseKey)
Defines the license identifier. |
void | setLicenseText(String license)
Defines a license text.
|
void | setLicenseTextFile(String file)
Defines a license text. |
void | setOtherText(String otherText)
Defines the additional text to show in the about dialog. |
void | setProductName(String name)
Defines the product name wich will be used in the KBugReport dialog.
|
void | setProgramLogo(QImage image)
Defines the program logo.
|
void | setProgramName(String programName)
Defines the displayable program name string. |
void | setShortDescription(String shortDescription)
Defines a short description of what the program does. |
void | setTranslator(String name, String emailAddress)
Sets the name of the translator of the gui. |
void | setVersion(String version)
Defines the program version string. |
String | shortDescription()
Returns a short, translated description. |
void | 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(). |
String | version()
Returns the program's version. |
UNKNOWN: Descibes the license of the software.
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.
UNKNOWN: Constructor.
Returns: a message about the translation team
UNKNOWN: Returns a message about the translation team.
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.
UNKNOWN: Defines an author.
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.
UNKNOWN: Defines a person that deserves credit.
Returns: the internal program name.
UNKNOWN: Returns the application's internal name.
Returns: the email address where to report bugs.
UNKNOWN: Returns the email address for bugs.
Returns: the copyright statement. Can be null if not set.
UNKNOWN: Returns the copyright statement.
Returns: the plain text displayed around the list of authors instead of the default message. Can be null.
UNKNOWN: 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 rich text displayed around the list of authors instead of the default message. Can be null.
UNKNOWN: Returns the rich text displayed around the list of authors instead of the default message telling users to send bug reports to bugAddress().
Returns: whether custom text should be displayed around the list of authors.
UNKNOWN: Returns whether custom text should be displayed around the list of authors.
Returns: the application homepage URL. Can be null if not set.
UNKNOWN: Returns the application homepage.
Returns: The license text.
UNKNOWN: Returns the license.
Returns: the free form text (translated). Can be null if not set.
UNKNOWN: Returns a translated, free form text.
Returns: the product name.
UNKNOWN: Returns the application's product name, which will be used in KBugReport dialog.
Returns: the program logo data or null image if there is no custom application logo defined.
UNKNOWN: Returns the program logo image.
Returns: the program name (translated).
UNKNOWN: Returns the translated program name.
Parameters: appName The application name. Example: "kate".
UNKNOWN: Defines the program name used internally.
Parameters: bugAddress The bug report email address string. This defaults to the kde.org bug system.
UNKNOWN: Defines the address where bug reports should be sent.
Parameters: 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.
UNKNOWN: Defines the copyright statement to show when displaying the license.
Parameters: plainText The plain text. richText The rich text. Both parameters can be null to not display any message at all. Call unsetCustomAuthorText() to revert to the default mesage.
UNKNOWN: Sets the custom text displayed around the list of authors instead of the default message telling users to send bug reports to bugAddress().
Parameters: homepage The program homepage string. Start the address with "http://". "http://kate.kde.org" is is correct, "kde.kde.org" is not.
UNKNOWN: Defines the program homepage.
Parameters: licenseKey The license identifier.
UNKNOWN: Defines the license identifier.
setLicenseText( I18N_NOOP("This is my license"));NOTE: No copy of the text is made.
Parameters: license The license text in utf8 encoding.
UNKNOWN: Defines a license text.
Parameters: file File containing the license text.
UNKNOWN: Defines a license text.
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.
UNKNOWN: Defines the additional text to show in the about dialog.
Parameters: name The name of product
UNKNOWN: Defines the product name wich will be used in the KBugReport dialog.
Parameters: image logo image.
See Also: KAboutData
UNKNOWN: Defines the program logo.
Parameters: programName The program name. This string should be marked for translation. Example: I18N_NOOP("Advanced Text Editor").
UNKNOWN: Defines the displayable program name string.
Parameters: shortDescription The program description This string should be marked for translation. Example: I18N_NOOP("An advanced text editor with syntax highlithing support.").
UNKNOWN: Defines a short description of what the program does.
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
UNKNOWN: Sets the name of the translator of the gui.
Parameters: version The program version.
UNKNOWN: Defines the program version string.
Returns: the short description (translated). Can be null if not set.
UNKNOWN: Returns a short, translated description.
UNKNOWN: 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().
Returns: the version string.
UNKNOWN: Returns the program's version.