packagestructure.h

Go to the documentation of this file.

/******************************************************************************
*   Copyright 2007 by Aaron Seigo <aseigo@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_PACKAGESTRUCTURE_H
#define PLASMA_PACKAGESTRUCTURE_H

#include <QtCore/QStringList>
#include <QtCore/QSharedData>

#include <kgenericfactory.h>
#include <klocale.h>
#include <ksharedptr.h>

#include <plasma/version.h>
#include "packagemetadata.h"

class KConfigBase;

namespace Plasma
{

class PackageStructurePrivate;

class PLASMA_EXPORT PackageStructure : public QObject, public QSharedData
{
    Q_OBJECT

public:
    typedef KSharedPtr<PackageStructure> Ptr;

    explicit PackageStructure(QObject *parent = 0,
                              const QString &type = i18nc("A non-functional package", "Invalid"));

    virtual ~PackageStructure();

    PackageStructure &operator=(const PackageStructure &rhs);

    static PackageStructure::Ptr load(const QString &packageFormat);

    QString type() const;

    QList<const char*> directories() const;

    QList<const char*> requiredDirectories() const;

    QList<const char*> files() const;

    QList<const char*> requiredFiles() const;

    void addDirectoryDefinition(const char *key, const QString &path, const QString &name);

    void addFileDefinition(const char *key, const QString &path, const QString &name);

    void removeDefinition(const char *key);

    QString path(const char *key) const;

    QStringList searchPath(const char *key) const;

    QStringList entryList(const char *key);

    QString name(const char *key) const;

    void setRequired(const char *key, bool required);

    bool isRequired(const char *key) const;

    void setDefaultMimetypes(QStringList mimetypes);

    void setMimetypes(const char *key, QStringList mimetypes);

    QStringList mimetypes(const char *key) const;

    void setPath(const QString &path);

    QString path() const;

    void read(const KConfigBase *config);

    void write(KConfigBase *config) const;

    virtual bool installPackage(const QString &archivePath, const QString &packageRoot);

    virtual bool uninstallPackage(const QString &packageName, const QString &packageRoot);

    virtual void createNewWidgetBrowser(QWidget *parent = 0);

    KDE_DEPRECATED QString contentsPrefix() const;

    QStringList contentsPrefixPaths() const;

    QString defaultPackageRoot() const;

    QString servicePrefix() const;

    void setServicePrefix(const QString &servicePrefix);

    virtual PackageMetadata metadata();

    bool allowExternalPaths() const;

Q_SIGNALS:
    void newWidgetBrowserFinished();

protected:
    void setAllowExternalPaths(bool allow);

    KDE_DEPRECATED void setContentsPrefix(const QString &prefix);

    void setContentsPrefixPaths(const QStringList &prefixPaths);

    void setDefaultPackageRoot(const QString &packageRoot);

    virtual void pathChanged();

private:
    PackageStructurePrivate * const d;
};

#define K_EXPORT_PLASMA_PACKAGESTRUCTURE(libname, classname) \
K_PLUGIN_FACTORY(factory, registerPlugin<classname>();) \
K_EXPORT_PLUGIN(factory("plasma_packagestructure_" #libname)) \
K_EXPORT_PLUGIN_VERSION(PLASMA_VERSION)

} // Plasma namespace
#endif