Plasma
Plasma::PackageMetadata Class Reference
Provides metadata for a Package. More...
#include <Plasma/PackageMetadata>
Public Member Functions | |
QString | application () const |
QString | author () const |
QString | category () const |
QString | description () const |
QString | email () const |
QString | implementationApi () const |
bool | isValid () const |
QStringList | keywords () const |
QString | license () const |
QString | name () const |
PackageMetadata (const PackageMetadata &other) | |
PackageMetadata (const QString &path=QString()) | |
QString | pluginName () const |
void | read (const QString &filename) |
QString | requiredVersion () const |
QString | serviceType () const |
void | setApplication (const QString &) |
void | setAuthor (const QString &) |
void | setCategory (const QString &) |
void | setDescription (const QString &) |
void | setEmail (const QString &) |
void | setImplementationApi (const QString &api) |
void | setKeywords (const QStringList &keywords) |
void | setLicense (const QString &) |
void | setName (const QString &) |
void | setPluginName (const QString &name) |
void | setRequiredVersion (const QString &) |
void | setServiceType (const QString &) |
void | setType (const QString &type) |
void | setVersion (const QString &) |
void | setWebsite (const QString &) |
QString | type () const |
QString | version () const |
QString | website () const |
void | write (const QString &filename) const |
~PackageMetadata () |
Detailed Description
Provides metadata for a Package.
Definition at line 37 of file packagemetadata.h.
Constructor & Destructor Documentation
Plasma::PackageMetadata::PackageMetadata | ( | const QString & | path = QString() |
) | [explicit] |
Constructs a metadata object using the values in the file at path.
- Parameters:
-
path path to a metadata.desktop file
Definition at line 60 of file packagemetadata.cpp.
Plasma::PackageMetadata::PackageMetadata | ( | const PackageMetadata & | other | ) |
Copy constructor.
Definition at line 55 of file packagemetadata.cpp.
Plasma::PackageMetadata::~PackageMetadata | ( | ) |
Definition at line 66 of file packagemetadata.cpp.
Member Function Documentation
QString Plasma::PackageMetadata::application | ( | ) | const |
Definition at line 166 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::author | ( | ) | const |
Definition at line 141 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::category | ( | ) | const |
Definition at line 171 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::description | ( | ) | const |
Definition at line 131 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::email | ( | ) | const |
Definition at line 146 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::implementationApi | ( | ) | const |
Definition at line 196 of file packagemetadata.cpp.
bool Plasma::PackageMetadata::isValid | ( | ) | const |
Definition at line 71 of file packagemetadata.cpp.
QStringList Plasma::PackageMetadata::keywords | ( | ) | const |
Definition at line 181 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::license | ( | ) | const |
Definition at line 161 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::name | ( | ) | const |
Definition at line 126 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::pluginName | ( | ) | const |
Definition at line 206 of file packagemetadata.cpp.
void Plasma::PackageMetadata::read | ( | const QString & | filename | ) |
Reads in metadata from a file, which should be a .desktop file.
It writes out the information in a format that is compatible with KPluginInfo
- See also:
- KPluginInfo
- filename path to the file to write to
Definition at line 101 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::requiredVersion | ( | ) | const |
Definition at line 186 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::serviceType | ( | ) | const |
Definition at line 136 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setApplication | ( | const QString & | application | ) |
Set the name of the application this package may belongs to.
This is used only for display purposes so far.
Definition at line 256 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setAuthor | ( | const QString & | author | ) |
Set the name of the author of the package.
Definition at line 231 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setCategory | ( | const QString & | category | ) |
Sets the category this package belongs in.
Definition at line 261 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setDescription | ( | const QString & | description | ) |
Set the description used to provide some general information what the package is about.
Definition at line 221 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setEmail | ( | const QString & | ) |
Set the E-Mail address of the author or of the project that provided the package.
Definition at line 236 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setImplementationApi | ( | const QString & | api | ) |
Set the implementation API this package uses.
Definition at line 201 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setKeywords | ( | const QStringList & | keywords | ) |
Set the keywords used to provide search and categorizations.
- Parameters:
-
keywords the keywords to associate with this package
Definition at line 176 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setLicense | ( | const QString & | license | ) |
Set the license the package is distributed under.
Definition at line 251 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setName | ( | const QString & | name | ) |
Set the name of the package used to displayed a short describing name.
Definition at line 216 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setPluginName | ( | const QString & | name | ) |
Set the plugin name of the package.
The plugin name is used to locate the package;
QString serviceName("plasma-applet-" + data.pluginName()); QString service = KStandardDirs::locateLocal("services", serviceName + ".desktop");
Definition at line 211 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setRequiredVersion | ( | const QString & | requiredVersion | ) |
Set the required version.
See also the setVersion() method.
Definition at line 266 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setServiceType | ( | const QString & | serviceType | ) |
Set the service-type which defines the X-KDE-ServiceTypes type within the desktop file.
If not defined this defaults to "Plasma/Applet,Plasma/Containment" in the desktop file.
Definition at line 226 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setType | ( | const QString & | type | ) |
Set the type of the package.
If not defined this defaults to "Service" in the desktop file.
Definition at line 271 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setVersion | ( | const QString & | version | ) |
Set the version of the package.
Definition at line 241 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setWebsite | ( | const QString & | website | ) |
Set the website URL where the package is hosted or where additional details about the project are available.
Definition at line 246 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::type | ( | ) | const |
Definition at line 191 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::version | ( | ) | const |
Definition at line 151 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::website | ( | ) | const |
Definition at line 156 of file packagemetadata.cpp.
void Plasma::PackageMetadata::write | ( | const QString & | filename | ) | const |
Writes out the metadata to filename, which should be a .desktop file.
It writes out the information in a format that is compatible with KPluginInfo
- See also:
- KPluginInfo
- filename path to the file to write to
Definition at line 79 of file packagemetadata.cpp.
The documentation for this class was generated from the following files: