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

Plasma

  • plasma
packagemetadata.h
Go to the documentation of this file.
1/******************************************************************************
2* Copyright 2007 by Riccardo Iaconelli <riccardo@kde.org> *
3* *
4* This library is free software; you can redistribute it and/or *
5* modify it under the terms of the GNU Library General Public *
6* License as published by the Free Software Foundation; either *
7* version 2 of the License, or (at your option) any later version. *
8* *
9* This library is distributed in the hope that it will be useful, *
10* but WITHOUT ANY WARRANTY; without even the implied warranty of *
11* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
12* Library General Public License for more details. *
13* *
14* You should have received a copy of the GNU Library General Public License *
15* along with this library; see the file COPYING.LIB. If not, write to *
16* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, *
17* Boston, MA 02110-1301, USA. *
18*******************************************************************************/
19
20#ifndef PLASMA_PACKAGEMETADATA_H
21#define PLASMA_PACKAGEMETADATA_H
22
23#include <QtCore/QString>
24
25#include <plasma/plasma_export.h>
26
27#include <kurl.h>
28
29namespace Plasma
30{
31
32class PackageMetadataPrivate;
33
39class PLASMA_EXPORT PackageMetadata
40{
41public:
47 explicit PackageMetadata(const QString &path = QString());
48
52 PackageMetadata(const PackageMetadata &other);
53
54 ~PackageMetadata();
55
56 PackageMetadata &operator=(const PackageMetadata &other);
57
58 bool isValid() const;
59
68 void write(const QString &filename) const;
69
78 void read(const QString &filename);
79
80 QString name() const;
81 QString description() const;
82 QStringList keywords() const;
83 QString serviceType() const;
84 QString author() const;
85 QString email() const;
86 QString version() const;
87 QString website() const;
88 QString license() const;
89 QString application() const;
90 QString category() const;
91 QString requiredVersion() const;
92 QString pluginName() const;
93 QString implementationApi() const;
94 KUrl remoteLocation() const;
95
96 QString type() const;
97
102 void setName(const QString &);
103
108 void setDescription(const QString &);
109
114 QString icon() const;
115
120 void setIcon(const QString &icon);
121
126 void setKeywords(const QStringList &keywords);
127
134 void setServiceType(const QString &);
135
139 void setAuthor(const QString &);
140
145 void setEmail(const QString &);
146
150 void setVersion(const QString &);
151
156 void setWebsite(const QString &);
157
161 void setLicense(const QString &);
162
168 void setApplication(const QString &);
169
173 void setCategory(const QString &);
174
179 void setRequiredVersion(const QString &);
180
184 void setRemoteLocation(const KUrl &);
185
190 void setType(const QString &type);
191
201 void setPluginName(const QString &name);
202
206 void setImplementationApi(const QString &api);
207
208private:
209 PackageMetadataPrivate * const d;
210};
211
212}
213#endif
Plasma::PackageMetadata::setWebsite
void setWebsite(const QString &)
Set the website URL where the package is hosted or where additional details about the project are ava...
Definition packagemetadata.cpp:294
Plasma::PackageMetadata::serviceType
QString serviceType() const
Definition packagemetadata.cpp:169
Plasma::PackageMetadata::isValid
bool isValid() const
Definition packagemetadata.cpp:79
Plasma::PackageMetadata::setLicense
void setLicense(const QString &)
Set the license the package is distributed under.
Definition packagemetadata.cpp:299
Plasma::PackageMetadata::icon
QString icon() const
Returns the icon name associated with this package, or QString() if none.
Definition packagemetadata.cpp:184
Plasma::PackageMetadata::setName
void setName(const QString &)
Set the name of the package used to displayed a short describing name.
Definition packagemetadata.cpp:264
Plasma::PackageMetadata::remoteLocation
KUrl remoteLocation() const
Definition packagemetadata.cpp:234
Plasma::PackageMetadata::operator=
PackageMetadata & operator=(const PackageMetadata &other)
Definition packagemetadata.cpp:62
Plasma::PackageMetadata::setApplication
void setApplication(const QString &)
Set the name of the application this package may belongs to.
Definition packagemetadata.cpp:304
Plasma::PackageMetadata::implementationApi
QString implementationApi() const
Definition packagemetadata.cpp:244
Plasma::PackageMetadata::setRequiredVersion
void setRequiredVersion(const QString &)
Set the required version.
Definition packagemetadata.cpp:314
Plasma::PackageMetadata::version
QString version() const
Definition packagemetadata.cpp:194
Plasma::PackageMetadata::application
QString application() const
Definition packagemetadata.cpp:209
Plasma::PackageMetadata::requiredVersion
QString requiredVersion() const
Definition packagemetadata.cpp:229
Plasma::PackageMetadata::category
QString category() const
Definition packagemetadata.cpp:214
Plasma::PackageMetadata::type
QString type() const
Definition packagemetadata.cpp:239
Plasma::PackageMetadata::setRemoteLocation
void setRemoteLocation(const KUrl &)
Set the url where this package is hosted.
Definition packagemetadata.cpp:319
Plasma::PackageMetadata::email
QString email() const
Definition packagemetadata.cpp:179
Plasma::PackageMetadata::description
QString description() const
Definition packagemetadata.cpp:164
Plasma::PackageMetadata::PackageMetadata
PackageMetadata(const QString &path=QString())
Constructs a metadata object using the values in the file at path.
Definition packagemetadata.cpp:68
Plasma::PackageMetadata::pluginName
QString pluginName() const
Definition packagemetadata.cpp:254
Plasma::PackageMetadata::author
QString author() const
Definition packagemetadata.cpp:174
Plasma::PackageMetadata::setServiceType
void setServiceType(const QString &)
Set the service-type which defines the X-KDE-ServiceTypes type within the desktop file.
Definition packagemetadata.cpp:274
Plasma::PackageMetadata::license
QString license() const
Definition packagemetadata.cpp:204
Plasma::PackageMetadata::setType
void setType(const QString &type)
Set the type of the package.
Definition packagemetadata.cpp:324
Plasma::PackageMetadata::setDescription
void setDescription(const QString &)
Set the description used to provide some general information what the package is about.
Definition packagemetadata.cpp:269
Plasma::PackageMetadata::setKeywords
void setKeywords(const QStringList &keywords)
Set the keywords used to provide search and categorizations.
Definition packagemetadata.cpp:219
Plasma::PackageMetadata::setCategory
void setCategory(const QString &)
Sets the category this package belongs in.
Definition packagemetadata.cpp:309
Plasma::PackageMetadata::setEmail
void setEmail(const QString &)
Set the E-Mail address of the author or of the project that provided the package.
Definition packagemetadata.cpp:284
Plasma::PackageMetadata::setImplementationApi
void setImplementationApi(const QString &api)
Set the implementation API this package uses.
Definition packagemetadata.cpp:249
Plasma::PackageMetadata::setIcon
void setIcon(const QString &icon)
Set the icon name to be used with this package.
Definition packagemetadata.cpp:189
Plasma::PackageMetadata::keywords
QStringList keywords() const
Definition packagemetadata.cpp:224
Plasma::PackageMetadata::write
void write(const QString &filename) const
Writes out the metadata to filename, which should be a .desktop file.
Definition packagemetadata.cpp:87
Plasma::PackageMetadata::read
void read(const QString &filename)
Reads in metadata from a file, which should be a .desktop file.
Definition packagemetadata.cpp:113
Plasma::PackageMetadata::setPluginName
void setPluginName(const QString &name)
Set the plugin name of the package.
Definition packagemetadata.cpp:259
Plasma::PackageMetadata::website
QString website() const
Definition packagemetadata.cpp:199
Plasma::PackageMetadata::setAuthor
void setAuthor(const QString &)
Set the name of the author of the package.
Definition packagemetadata.cpp:279
Plasma::PackageMetadata::name
QString name() const
Definition packagemetadata.cpp:159
Plasma::PackageMetadata::setVersion
void setVersion(const QString &)
Set the version of the package.
Definition packagemetadata.cpp:289
Plasma
Namespace for everything in libplasma.
Definition abstractdialogmanager.cpp:25
plasma_export.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Tue Mar 25 2025 00:00:00 by doxygen 1.13.2 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.14.38 API Reference

Skip menu "kdelibs-4.14.38 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