|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kde.koala.KAboutData
public class KAboutData
This class is used to store information about a program. 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).
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(java.lang.Class dummy)
|
|
KAboutData(java.lang.String appName,
java.lang.String programName,
java.lang.String version)
|
|
KAboutData(java.lang.String appName,
java.lang.String programName,
java.lang.String version,
java.lang.String shortDescription)
|
|
KAboutData(java.lang.String appName,
java.lang.String programName,
java.lang.String version,
java.lang.String shortDescription,
int licenseType)
|
|
KAboutData(java.lang.String appName,
java.lang.String programName,
java.lang.String version,
java.lang.String shortDescription,
int licenseType,
java.lang.String copyrightStatement)
|
|
KAboutData(java.lang.String appName,
java.lang.String programName,
java.lang.String version,
java.lang.String shortDescription,
int licenseType,
java.lang.String copyrightStatement,
java.lang.String text)
|
|
KAboutData(java.lang.String appName,
java.lang.String programName,
java.lang.String version,
java.lang.String shortDescription,
int licenseType,
java.lang.String copyrightStatement,
java.lang.String text,
java.lang.String homePageAddress)
|
|
KAboutData(java.lang.String appName,
java.lang.String programName,
java.lang.String version,
java.lang.String shortDescription,
int licenseType,
java.lang.String copyrightStatement,
java.lang.String text,
java.lang.String homePageAddress,
java.lang.String bugsEmailAddress)
Constructor. |
Method Summary | |
---|---|
static java.lang.String |
aboutTranslationTeam()
Returns a message about the translation team. |
void |
addAuthor(java.lang.String name)
|
void |
addAuthor(java.lang.String name,
java.lang.String task)
|
void |
addAuthor(java.lang.String name,
java.lang.String task,
java.lang.String emailAddress)
|
void |
addAuthor(java.lang.String name,
java.lang.String task,
java.lang.String emailAddress,
java.lang.String webAddress)
Defines an author. |
void |
addCredit(java.lang.String name)
|
void |
addCredit(java.lang.String name,
java.lang.String task)
|
void |
addCredit(java.lang.String name,
java.lang.String task,
java.lang.String emailAddress)
|
void |
addCredit(java.lang.String name,
java.lang.String task,
java.lang.String emailAddress,
java.lang.String webAddress)
Defines a person that deserves credit. |
java.lang.String |
appName()
Returns the application's internal name. |
java.lang.String |
bugAddress()
Returns the email address for bugs. |
java.lang.String |
copyrightStatement()
Returns the copyright statement. |
java.lang.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(). |
java.lang.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 |
java.lang.String |
homepage()
Returns the application homepage. |
boolean |
isDisposed()
Has the wrapped C++ instance been deleted? |
java.lang.String |
license()
Returns the license. |
java.lang.String |
otherText()
Returns a translated, free form text. |
java.lang.String |
productName()
Returns the application's product name, which will be used in KBugReport dialog. |
org.kde.qt.QImage |
programLogo()
Returns the program logo image. |
java.lang.String |
programName()
Returns the translated program name. |
void |
setAppName(java.lang.String appName)
Defines the program name used internally. |
void |
setBugAddress(java.lang.String bugAddress)
Defines the address where bug reports should be sent. |
void |
setCopyrightStatement(java.lang.String copyrightStatement)
Defines the copyright statement to show when displaying the license. |
void |
setCustomAuthorText(java.lang.String plainText,
java.lang.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(java.lang.String homepage)
Defines the program homepage. |
void |
setLicense(int licenseKey)
Defines the license identifier. |
void |
setLicenseText(java.lang.String license)
Defines a license text. |
void |
setLicenseTextFile(java.lang.String file)
Defines a license text. |
void |
setOtherText(java.lang.String otherText)
Defines the additional text to show in the about dialog. |
void |
setProductName(java.lang.String name)
Defines the product name wich will be used in the KBugReport dialog. |
void |
setProgramLogo(org.kde.qt.QImage image)
Defines the program logo. |
void |
setProgramName(java.lang.String programName)
Defines the displayable program name string. |
void |
setShortDescription(java.lang.String shortDescription)
Defines a short description of what the program does. |
void |
setTranslator(java.lang.String name,
java.lang.String emailAddress)
Sets the name of the translator of the gui. |
void |
setVersion(java.lang.String version)
Defines the program version string. |
java.lang.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(). |
java.lang.String |
version()
Returns the program's version. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int License_Custom
public static final int License_File
public static final int License_Unknown
public static final int License_GPL
public static final int License_GPL_V2
public static final int License_LGPL
public static final int License_LGPL_V2
public static final int License_BSD
public static final int License_Artistic
public static final int License_QPL
public static final int License_QPL_V1_0
Constructor Detail |
---|
protected KAboutData(java.lang.Class dummy)
public KAboutData(java.lang.String appName, java.lang.String programName, java.lang.String version, java.lang.String shortDescription, int licenseType, java.lang.String copyrightStatement, java.lang.String text, java.lang.String homePageAddress, java.lang.String bugsEmailAddress)
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.public KAboutData(java.lang.String appName, java.lang.String programName, java.lang.String version, java.lang.String shortDescription, int licenseType, java.lang.String copyrightStatement, java.lang.String text, java.lang.String homePageAddress)
public KAboutData(java.lang.String appName, java.lang.String programName, java.lang.String version, java.lang.String shortDescription, int licenseType, java.lang.String copyrightStatement, java.lang.String text)
public KAboutData(java.lang.String appName, java.lang.String programName, java.lang.String version, java.lang.String shortDescription, int licenseType, java.lang.String copyrightStatement)
public KAboutData(java.lang.String appName, java.lang.String programName, java.lang.String version, java.lang.String shortDescription, int licenseType)
public KAboutData(java.lang.String appName, java.lang.String programName, java.lang.String version, java.lang.String shortDescription)
public KAboutData(java.lang.String appName, java.lang.String programName, java.lang.String version)
Method Detail |
---|
public void addAuthor(java.lang.String name, java.lang.String task, java.lang.String emailAddress, java.lang.String webAddress)
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.public void addAuthor(java.lang.String name, java.lang.String task, java.lang.String emailAddress)
public void addAuthor(java.lang.String name, java.lang.String task)
public void addAuthor(java.lang.String name)
public void addCredit(java.lang.String name, java.lang.String task, java.lang.String emailAddress, java.lang.String webAddress)
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.public void addCredit(java.lang.String name, java.lang.String task, java.lang.String emailAddress)
public void addCredit(java.lang.String name, java.lang.String task)
public void addCredit(java.lang.String name)
public void setTranslator(java.lang.String name, java.lang.String emailAddress)
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.
name
- the name of the translatoremailAddress
- the email address of the translatorKAboutTranslator
public void setLicenseText(java.lang.String license)
setLicenseText( I18N_NOOP("This is my license"));NOTE: No copy of the text is made.
license
- The license text in utf8 encoding.public void setLicenseTextFile(java.lang.String file)
file
- File containing the license text.public void setAppName(java.lang.String appName)
appName
- The application name. Example: "kate".public void setProgramName(java.lang.String programName)
programName
- The program name. This string should be
marked for translation.
Example: I18N_NOOP("Advanced Text Editor").public void setProgramLogo(org.kde.qt.QImage image)
image
- logo image.programLogo()
public void setVersion(java.lang.String version)
version
- The program version.public void setShortDescription(java.lang.String shortDescription)
shortDescription
- The program description This string should be marked
for translation. Example: I18N_NOOP("An advanced text editor
with syntax highlithing support.").public void setLicense(int licenseKey)
licenseKey
- The license identifier.public void setCopyrightStatement(java.lang.String copyrightStatement)
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.public void setOtherText(java.lang.String otherText)
otherText
- Some free form text, that can contain any kind of
information. The text can contain newlines. This string
should be marked for translation.public void setHomepage(java.lang.String homepage)
homepage
- The program homepage string.
Start the address with "http://". "http://kate.kde.org" is
is correct, "kde.kde.org" is not.public void setBugAddress(java.lang.String bugAddress)
bugAddress
- The bug report email address string.
This defaults to the kde.org bug system.public void setProductName(java.lang.String name)
name
- The name of productpublic java.lang.String appName()
public java.lang.String productName()
public java.lang.String programName()
public org.kde.qt.QImage programLogo()
public java.lang.String version()
public java.lang.String shortDescription()
public java.lang.String homepage()
public java.lang.String bugAddress()
public java.lang.String otherText()
public java.lang.String license()
public java.lang.String copyrightStatement()
public java.lang.String customAuthorPlainText()
public java.lang.String customAuthorRichText()
public boolean customAuthorTextEnabled()
public void setCustomAuthorText(java.lang.String plainText, java.lang.String richText)
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.public void unsetCustomAuthorText()
public static java.lang.String aboutTranslationTeam()
protected void finalize() throws java.lang.InternalError
finalize
in class java.lang.Object
java.lang.InternalError
public void dispose()
public boolean isDisposed()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |