Plasma
Plasma::PackageMetadata Class Reference
Provides metadata for a Package. More...
#include <Plasma/PackageMetadata>
Detailed Description
Provides metadata for a Package.Definition at line 37 of file packagemetadata.h.
Constructor & Destructor Documentation
Constructs a metadata object using the values in the file at path.
- Parameters:
-
path path to a metadata.desktop file
Definition at line 59 of file packagemetadata.cpp.
Plasma::PackageMetadata::PackageMetadata | ( | const PackageMetadata & | other | ) |
Plasma::PackageMetadata::~PackageMetadata | ( | ) |
Definition at line 65 of file packagemetadata.cpp.
Member Function Documentation
QString Plasma::PackageMetadata::application | ( | ) | const |
Definition at line 165 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::author | ( | ) | const |
Definition at line 140 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::category | ( | ) | const |
Definition at line 170 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::description | ( | ) | const |
Definition at line 130 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::email | ( | ) | const |
Definition at line 145 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::implementationApi | ( | ) | const |
Definition at line 185 of file packagemetadata.cpp.
bool Plasma::PackageMetadata::isValid | ( | ) | const |
Definition at line 70 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::license | ( | ) | const |
Definition at line 160 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::name | ( | ) | const |
Definition at line 125 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::pluginName | ( | ) | const |
Definition at line 195 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 175 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::serviceType | ( | ) | const |
Definition at line 135 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 245 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setAuthor | ( | const QString & | author | ) |
void Plasma::PackageMetadata::setCategory | ( | const QString & | category | ) |
void Plasma::PackageMetadata::setDescription | ( | const QString & | description | ) |
Set the description used to provide some general information what the package is about.
Definition at line 210 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 225 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setImplementationApi | ( | const QString & | api | ) |
void Plasma::PackageMetadata::setLicense | ( | const QString & | license | ) |
Set the license the package is distributed under.
Definition at line 240 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 205 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 200 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setRequiredVersion | ( | const QString & | requiredVersion | ) |
Set the required version.
See also the setVersion() method.
Definition at line 255 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 215 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 260 of file packagemetadata.cpp.
void Plasma::PackageMetadata::setVersion | ( | const QString & | version | ) |
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 235 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::type | ( | ) | const |
Definition at line 180 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::version | ( | ) | const |
Definition at line 150 of file packagemetadata.cpp.
QString Plasma::PackageMetadata::website | ( | ) | const |
Definition at line 155 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 80 of file packagemetadata.cpp.
The documentation for this class was generated from the following files: