packagemetadata.h

Go to the documentation of this file.

/******************************************************************************
*   Copyright 2007 by Riccardo Iaconelli  <riccardo@kde.org>                  *
*                                                                             *
*   This library is free software; you can redistribute it and/or             *
*   modify it under the terms of the GNU Library General Public               *
*   License as published by the Free Software Foundation; either              *
*   version 2 of the License, or (at your option) any later version.          *
*                                                                             *
*   This library is distributed in the hope that it will be useful,           *
*   but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU          *
*   Library General Public License for more details.                          *
*                                                                             *
*   You should have received a copy of the GNU Library General Public License *
*   along with this library; see the file COPYING.LIB.  If not, write to      *
*   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,      *
*   Boston, MA 02110-1301, USA.                                               *
*******************************************************************************/

#ifndef PLASMA_PACKAGEMETADATA_H
#define PLASMA_PACKAGEMETADATA_H

#include <QtCore/QString>

#include <plasma/plasma_export.h>

#include <kurl.h>

namespace Plasma
{

class PackageMetadataPrivate;

class PLASMA_EXPORT PackageMetadata
{
public:
    explicit PackageMetadata(const QString &path = QString());

    PackageMetadata(const PackageMetadata &other);

    ~PackageMetadata();

    PackageMetadata &operator=(const PackageMetadata &other);
    
    bool isValid() const;

    void write(const QString &filename) const;

    void read(const QString &filename);

    QString name() const;
    QString description() const;
    QStringList keywords() const;
    QString serviceType() const;
    QString author() const;
    QString email() const;
    QString version() const;
    QString website() const;
    QString license() const;
    QString application() const;
    QString category() const;
    QString requiredVersion() const;
    QString pluginName() const;
    QString implementationApi() const;
    KUrl remoteLocation() const;

    QString type() const;

    void setName(const QString &);

    void setDescription(const QString &);

    QString icon() const;

    void setIcon(const QString &icon);

    void setKeywords(const QStringList &keywords);

    void setServiceType(const QString &);

    void setAuthor(const QString &);

    void setEmail(const QString &);

    void setVersion(const QString &);

    void setWebsite(const QString &);

    void setLicense(const QString &);

    void setApplication(const QString &);

    void setCategory(const QString &);

    void setRequiredVersion(const QString &);

    void setRemoteLocation(const KUrl &);

    void setType(const QString &type);

    void setPluginName(const QString &name);

    void setImplementationApi(const QString &api);

private:
    PackageMetadataPrivate * const d;
};

}
#endif