kplugininfo.h

Go to the documentation of this file.

/*  This file is part of the KDE project
    Copyright (C) 2003,2007 Matthias Kretz <kretz@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 version 2 as published by the Free Software Foundation.

    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 KDECORE_KPLUGININFO_H
#define KDECORE_KPLUGININFO_H

#include <QtCore/QExplicitlySharedDataPointer>
#include <QtCore/QString>
#include <QtCore/QMap>
#include <QtCore/QStringList>

#include <kconfiggroup.h>
#include <kservice.h>
#include <kaboutdata.h>
#include <QtCore/QList>

class KPluginInfoPrivate;

class KDECORE_EXPORT KPluginInfo
{
    public:
        typedef QList<KPluginInfo> List;

        explicit KPluginInfo( const QString & filename, const char* resource = 0 );

        explicit KPluginInfo( const KService::Ptr service );

        KPluginInfo();

        ~KPluginInfo();

        static KPluginInfo::List fromServices(const KService::List &services, const KConfigGroup &config = KConfigGroup());

        static KPluginInfo::List fromFiles(const QStringList &files, const KConfigGroup &config = KConfigGroup());

        static KPluginInfo::List fromKPartsInstanceName(const QString &componentName, const KConfigGroup &config = KConfigGroup());

        bool isHidden() const;

        void setPluginEnabled(bool enabled);

        bool isPluginEnabled() const;

        bool isPluginEnabledByDefault() const;

        QVariant property( const QString & key ) const;

        QString name() const;

        QString comment() const;

        QString icon() const;

        QString entryPath() const;

        QString author() const;

        QString email() const;

        QString category() const;

        QString pluginName() const;

        QString version() const;

        QString website() const;


        QString license() const;

        KAboutLicense fullLicense() const;

        QStringList dependencies() const;

        KService::Ptr service() const;

        QList<KService::Ptr> kcmServices() const;

        void setConfig(const KConfigGroup &config);

        KConfigGroup config() const;

        void save(KConfigGroup config = KConfigGroup());

        void load(const KConfigGroup &config = KConfigGroup());

        void defaults();

        bool isValid() const;

        KPluginInfo(const KPluginInfo &copy);

        KPluginInfo &operator=(const KPluginInfo &rhs);

        bool operator==(const KPluginInfo &rhs) const;

        bool operator!=(const KPluginInfo &rhs) const;

        bool operator<(const KPluginInfo &rhs) const;

        bool operator>(const KPluginInfo &rhs) const;

    private:
        friend KDECORE_EXPORT uint qHash(const KPluginInfo &);
        QExplicitlySharedDataPointer<KPluginInfoPrivate> d;
};

KDECORE_EXPORT uint qHash(const KPluginInfo &);

#endif // KDECORE_KPLUGININFO_H