#include <kdevplugininfo.h>
Public Member Functions | |
KDevPluginInfo (const TQString &pluginName) | |
operator TDEAboutData * () const | |
TQString | pluginName () const |
TQString | genericName () const |
TQString | icon () const |
TQString | description () const |
TQString | version () const |
int | licenseType () const |
TQString | license () const |
TQString | copyrightStatement () const |
TQString | homePageAddress () const |
TQString | bugsEmailAddress () const |
TQVariant | property (const TQString &name) const |
TQVariant | operator[] (const TQString &name) const |
TQStringList | propertyNames () const |
const TQValueList< TDEAboutPerson > | authors () const |
const TQValueList< TDEAboutPerson > | credits () const |
void | addAuthor (const char *name, const char *task, 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) |
Detailed Description
Information about TDevelop plugin.
It uses plugin name to query plugin .desktop files and retrieve most information. Names of authors and credits to other people must be added manually using KDevPluginInfo::addAuthor and KDevPluginInfo::addCredit methods.
- See also
- KDevPlugin class documentation for more information about .desktop files.
Definition at line 39 of file kdevplugininfo.h.
Constructor & Destructor Documentation
◆ KDevPluginInfo()
KDevPluginInfo::KDevPluginInfo | ( | const TQString & | pluginName | ) |
Constructor.
- Parameters
-
pluginName A name of a plugin. Must be the same as the name of a .desktop file and the same as the location of plugin resource files.
Definition at line 49 of file kdevplugininfo.cpp.
Member Function Documentation
◆ addAuthor()
void KDevPluginInfo::addAuthor | ( | const char * | name, |
const char * | task, | ||
const char * | emailAddress = 0 , |
||
const char * | webAddress = 0 |
||
) |
Adds an author to the list of authors.
You can call this function as many times you need. Each entry is appended to a list.
- 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.
Definition at line 171 of file kdevplugininfo.cpp.
◆ addCredit()
void KDevPluginInfo::addCredit | ( | const char * | name, |
const char * | task = 0 , |
||
const char * | emailAddress = 0 , |
||
const char * | webAddress = 0 |
||
) |
Adds a contributor to the list of contributors.
You can call this function as many times you need. Each entry is appended to a list.
- 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.
Definition at line 177 of file kdevplugininfo.cpp.
◆ authors()
const TQValueList<TDEAboutPerson> KDevPluginInfo::authors | ( | ) | const |
- Returns
- A list of plugin authors.
◆ bugsEmailAddress()
TQString KDevPluginInfo::bugsEmailAddress | ( | ) | const |
- Returns
- A email address for bugs of a plugin. Information is taken from .desktop file.
Definition at line 145 of file kdevplugininfo.cpp.
◆ copyrightStatement()
TQString KDevPluginInfo::copyrightStatement | ( | ) | const |
- Returns
- A copyright statement of a plugin. Information is taken from .desktop file.
Definition at line 135 of file kdevplugininfo.cpp.
◆ credits()
const TQValueList<TDEAboutPerson> KDevPluginInfo::credits | ( | ) | const |
- Returns
- A list of other plugin contributors.
◆ description()
TQString KDevPluginInfo::description | ( | ) | const |
- Returns
- A description of a plugin. Information is taken from .desktop file.
Definition at line 112 of file kdevplugininfo.cpp.
◆ genericName()
TQString KDevPluginInfo::genericName | ( | ) | const |
- Returns
- A generic name of a plugin (translated). Use this in GUI. Information is taken from .desktop file.
Definition at line 102 of file kdevplugininfo.cpp.
◆ homePageAddress()
TQString KDevPluginInfo::homePageAddress | ( | ) | const |
- Returns
- A home page of a plugin. Information is taken from .desktop file.
Definition at line 140 of file kdevplugininfo.cpp.
◆ icon()
TQString KDevPluginInfo::icon | ( | ) | const |
- Returns
- An icon name of a plugin. Information is taken from .desktop file.
Definition at line 107 of file kdevplugininfo.cpp.
◆ license()
TQString KDevPluginInfo::license | ( | ) | const |
- Returns
- A license text for known license types (GPL, LGPL, BSD, Artistic, TQPL).
Definition at line 127 of file kdevplugininfo.cpp.
◆ licenseType()
int KDevPluginInfo::licenseType | ( | ) | const |
- Returns
- A license type of a plugin. Information is taken from .desktop file.
Definition at line 122 of file kdevplugininfo.cpp.
◆ operator TDEAboutData *()
KDevPluginInfo::operator TDEAboutData * | ( | ) | const |
Casts KDevPluginInfo to TDEAboutData.
Uses KDevPluginInfo::pluginName as TDEAboutData::appName, KDevPluginInfo::rawGenericName as TDEAboutData::programName KDevPluginInfo::licenseType as TDEAboutData::licenseType. Other parameters are ignored.
Definition at line 92 of file kdevplugininfo.cpp.
◆ operator[]()
TQVariant KDevPluginInfo::operator[] | ( | const TQString & | name | ) | const |
- Parameters
-
name The name of a property.
- Returns
- Any property value which exists in .desktop file.
Definition at line 158 of file kdevplugininfo.cpp.
◆ pluginName()
TQString KDevPluginInfo::pluginName | ( | ) | const |
- Returns
- A name of a plugin (always untranslated).
Definition at line 97 of file kdevplugininfo.cpp.
◆ property()
TQVariant KDevPluginInfo::property | ( | const TQString & | name | ) | const |
- Parameters
-
name The name of a property.
- Returns
- Any property value which exists in .desktop file.
Definition at line 150 of file kdevplugininfo.cpp.
◆ propertyNames()
TQStringList KDevPluginInfo::propertyNames | ( | ) | const |
- Returns
- A list of property names set in .desktop file.
Definition at line 163 of file kdevplugininfo.cpp.
◆ version()
TQString KDevPluginInfo::version | ( | ) | const |
- Returns
- A version of a plugin. Information is taken from .desktop file.
Definition at line 117 of file kdevplugininfo.cpp.
The documentation for this class was generated from the following files: