package.h

Go to the documentation of this file.

/******************************************************************************
*   Copyright 2007 by Aaron Seigo <aseigo@kde.org>                        *
*   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_PACKAGE_H
#define PLASMA_PACKAGE_H

#include <QtCore/QStringList>

#include <plasma/plasma.h>
#include <plasma/packagestructure.h>
#include <plasma/plasma_export.h>

namespace Plasma
{

class PackageMetadata;
class PackagePrivate;

class PLASMA_EXPORT Package
{
    public:
        explicit Package();

        Package(const QString &packageRoot, const QString &package,
                PackageStructure::Ptr structure);

        Package(const QString &packagePath, PackageStructure::Ptr structure);

        Package(const Package &other);

        ~Package();

        Package &operator=(const Package &rhs);

        bool isValid() const;

        QString filePath(const char *fileType, const QString &filename) const;

        QString filePath(const char *fileType) const;

        QStringList entryList(const char *fileType) const;

        PackageMetadata metadata() const;

        void setPath(const QString &path);

        void publish(AnnouncementMethods methods, const QString &name);

        void unpublish(const QString &name = QString());

        bool isPublished() const;

        const QString path() const;

        const PackageStructure::Ptr structure() const;

        QString contentsHash() const;

        static QStringList listInstalled(const QString &packageRoot);

        static QStringList listInstalledPaths(const QString &packageRoot);

        static bool installPackage(const QString &package,
                                   const QString &packageRoot,
                                   const QString &servicePrefix);

        static bool uninstallPackage(const QString &package,
                                     const QString &packageRoot,
                                     const QString &servicePrefix);

        static bool registerPackage(const PackageMetadata &data, const QString &iconPath);

        static bool createPackage(const PackageMetadata &metadata,
                                  const QString &source,
                                  const QString &destination,
                                  const QString &icon = QString());

    private:
        PackagePrivate * const d;

        friend class Applet;
        friend class AppletPrivate;
};

} // Namespace

Q_DECLARE_METATYPE(Plasma::Package)
#endif