KAboutPerson Class Reference
#include <kaboutdata.h>
Public Member Functions | |
KAboutPerson (const char *name, const char *task, const char *emailAddress, const char *webAddress) | |
TQString | name () const |
TQString | task () const |
TQString | emailAddress () const |
TQString | webAddress () const |
Detailed Description
This structure is used to store information about a person or developer.
It can store the person's name, a task, an email address and a link to a home page. This class is intended for use in the KAboutData class, but it can be used elsewhere as well. Normally you should at least define the person's name.
Example Usage within a main():
I18N_NOOP("A KDE version of Hello, world!"),
KAboutData::License_LGPL,
I18N_NOOP("Copyright (c) 2003 Developer"));
about.addAuthor("Joe Developer", I18N_NOOP("developer"), "joe@host.com", 0);
about.addCredit("Joe User", I18N_NOOP("A lot of bug reports"),
"joe.user@host.org", 0);
KCmdLineArgs::init(argc, argv, &about);
static void init(int _argc, char **_argv, const char *_appname, const char *programName, const char *_description, const char *_version, bool noKApp=false)
Initialize class.
Definition: kcmdlineargs.cpp:127
Definition at line 54 of file kaboutdata.h.
Constructor & Destructor Documentation
◆ KAboutPerson()
|
inline |
Convenience constructor.
- Parameters
-
name The name of the person. task The task of this person. This string should be marked for translation, e.g. I18N_NOOP("Task description....") emailAddress The email address of the person. webAddress Home page of the person.
Definition at line 70 of file kaboutdata.h.
Member Function Documentation
◆ emailAddress()
TQString KAboutPerson::emailAddress | ( | ) | const |
The person's email address.
- Returns
- the person's email address (can be TQString::null, if it has been constructed with a null email)
Definition at line 44 of file kaboutdata.cpp.
◆ name()
TQString KAboutPerson::name | ( | ) | const |
The person's name.
- Returns
- the person's name (can be TQString::null, if it has been constructed with a null name)
Definition at line 29 of file kaboutdata.cpp.
◆ task()
TQString KAboutPerson::task | ( | ) | const |
The person's task.
- Returns
- the person's task (can be TQString::null, if it has been constructed with a null task)
Definition at line 35 of file kaboutdata.cpp.
◆ webAddress()
TQString KAboutPerson::webAddress | ( | ) | const |
The home page or a relevant link.
- Returns
- the persons home page (can be TQString::null, if it has been constructed with a null home page)
Definition at line 51 of file kaboutdata.cpp.
The documentation for this class was generated from the following files: