• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Plasma

Plasma::PackageMetadata

Plasma::PackageMetadata Class Reference

Provides metadata for a Package. More...

#include <Plasma/PackageMetadata>

List of all members.


Public Member Functions

QString application () const
QString author () const
QString category () const
QString description () const
QString email () const
QString implementationApi () const
bool isValid () 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 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 59 of file packagemetadata.cpp.

Plasma::PackageMetadata::PackageMetadata ( const PackageMetadata &  other  ) 

Copy constructor.

Definition at line 54 of file packagemetadata.cpp.

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  ) 

Set the name of the author of the package.

Definition at line 220 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setCategory ( const QString &  category  ) 

Sets the category this package belongs in.

Definition at line 250 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 210 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setEmail ( const QString &  email  ) 

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  ) 

Set the implementation API this package uses.

Definition at line 190 of file packagemetadata.cpp.

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  ) 

Set the version of the package.

Definition at line 230 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 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:
  • packagemetadata.h
  • packagemetadata.cpp

Plasma

Skip menu "Plasma"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal