• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

Plasma

  • Plasma
  • PackageMetadata
Public Member Functions
Plasma::PackageMetadata Class Reference

#include <Plasma/PackageMetadata>

List of all members.

Public Member Functions

 PackageMetadata (const QString &path=QString())
 PackageMetadata (const PackageMetadata &other)
 ~PackageMetadata ()
QString application () const
QString author () const
QString category () const
QString description () const
QString email () const
QString icon () const
QString implementationApi () const
bool isValid () const
QStringList keywords () const
QString license () const
QString name () const
PackageMetadata & operator= (const PackageMetadata &other)
QString pluginName () const
void read (const QString &filename)
KUrl remoteLocation () const
QStringList requiredDataEngines () const
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 setIcon (const QString &icon)
void setImplementationApi (const QString &api)
void setKeywords (const QStringList &keywords)
void setLicense (const QString &)
void setName (const QString &)
void setPluginName (const QString &name)
void setRemoteLocation (const KUrl &)
void setRequiredDataEngines (const QStringList &)
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

Detailed Description

Provides metadata for a Package.

Definition at line 40 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:
pathpath to a metadata.desktop file

Definition at line 69 of file packagemetadata.cpp.

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

Copy constructor.

Definition at line 58 of file packagemetadata.cpp.

Plasma::PackageMetadata::~PackageMetadata ( )

Definition at line 75 of file packagemetadata.cpp.


Member Function Documentation

QString Plasma::PackageMetadata::application ( ) const

Definition at line 212 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::author ( ) const

Definition at line 177 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::category ( ) const

Definition at line 217 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::description ( ) const

Definition at line 167 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::email ( ) const

Definition at line 182 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::icon ( ) const

Returns the icon name associated with this package, or QString() if none.

Since:
4.5

Definition at line 187 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::implementationApi ( ) const

Definition at line 247 of file packagemetadata.cpp.

bool Plasma::PackageMetadata::isValid ( ) const

Definition at line 80 of file packagemetadata.cpp.

QStringList Plasma::PackageMetadata::keywords ( ) const

Definition at line 227 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::license ( ) const

Definition at line 207 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::name ( ) const

Definition at line 162 of file packagemetadata.cpp.

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

Definition at line 63 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::pluginName ( ) const

Definition at line 262 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
Parameters:
filenamepath to the file to write to

Definition at line 115 of file packagemetadata.cpp.

KUrl Plasma::PackageMetadata::remoteLocation ( ) const

Definition at line 237 of file packagemetadata.cpp.

QStringList Plasma::PackageMetadata::requiredDataEngines ( ) const

Definition at line 252 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::requiredVersion ( ) const

Definition at line 232 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::serviceType ( ) const

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

void Plasma::PackageMetadata::setAuthor ( const QString &  author)

Set the name of the author of the package.

Definition at line 287 of file packagemetadata.cpp.

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

Sets the category this package belongs in.

Definition at line 317 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 277 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 292 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setIcon ( const QString &  icon)

Set the icon name to be used with this package.

Since:
4.5

Definition at line 192 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setImplementationApi ( const QString &  api)

Set the implementation API this package uses.

Definition at line 257 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setKeywords ( const QStringList &  keywords)

Set the keywords used to provide search and categorizations.

Parameters:
keywordsthe keywords to associate with this package

Definition at line 222 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setLicense ( const QString &  license)

Set the license the package is distributed under.

Definition at line 307 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 272 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 267 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setRemoteLocation ( const KUrl &  location)

Set the url where this package is hosted.

Definition at line 327 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setRequiredDataEngines ( const QStringList &  requiredDataEngines)

Set the required data engines for this package.

Definition at line 332 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setRequiredVersion ( const QString &  requiredVersion)

Set the required version.

See also the setVersion() method.

Definition at line 322 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 282 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 337 of file packagemetadata.cpp.

void Plasma::PackageMetadata::setVersion ( const QString &  version)

Set the version of the package.

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

QString Plasma::PackageMetadata::type ( ) const

Definition at line 242 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::version ( ) const

Definition at line 197 of file packagemetadata.cpp.

QString Plasma::PackageMetadata::website ( ) const

Definition at line 202 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
Parameters:
filenamepath to the file to write to

Definition at line 88 of file packagemetadata.cpp.


The documentation for this class was generated from the following files:
  • packagemetadata.h
  • packagemetadata.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 23 2013 20:31:09 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Plasma

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

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal