kplugininfo.h

/*  This file is part of the KDE project
    Copyright (C) 2003 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 KPLUGININFO_H
#define KPLUGININFO_H
 
#include <tqstring.h>
#include <tqmap.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
#include <kservice.h>
 
class TDEConfigGroup;

class TDEUTILS_EXPORT KPluginInfo
{
    public:
        typedef TQValueList<KPluginInfo*> List;

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

        KPluginInfo( const KService::Ptr service );
 
//X         /**
//X          * Create an empty hidden plugin.
//X          * @internal
//X          */
//X         KPluginInfo();
 
        virtual ~KPluginInfo();

        static KPluginInfo::List fromServices( const KService::List & services, TDEConfig * config = 0, const TQString & group = TQString::null );

        static KPluginInfo::List fromFiles( const TQStringList & files, TDEConfig * config = 0, const TQString & group = TQString::null );

        static KPluginInfo::List fromKPartsInstanceName( const TQString &, TDEConfig * config = 0, const TQString & group = TQString::null );

        bool isHidden() const;

        virtual void setPluginEnabled( bool enabled );

        virtual bool isPluginEnabled() const;

        bool isPluginEnabledByDefault() const;

        TQVariant property( const TQString & key ) const;

        TQVariant operator[]( const TQString & key ) const;

        const TQString & name() const;

        const TQString & comment() const;

        const TQString & icon() const;

        const TQString & specfile() const;

        const TQString & author() const;

        const TQString & email() const;

        const TQString & category() const;

        const TQString & pluginName() const;

        const TQString & version() const;

        const TQString & website() const;
 

        const TQString & license() const;

        const TQStringList & dependencies() const;

        KService::Ptr service() const;

        const TQValueList<KService::Ptr> & kcmServices() const;

        void setConfig( TDEConfig * config, const TQString & group );

        TDEConfig * config() const;

        const TQString & configgroup() const;

        virtual void save( TDEConfigGroup * config = 0 );

        virtual void load( TDEConfigGroup * config = 0 );

        virtual void defaults();
 
    private:
        KPluginInfo( const KPluginInfo & );
        const KPluginInfo & operator=( const KPluginInfo & );
 
        class KPluginInfoPrivate;
        KPluginInfoPrivate * d;
};
#endif // KPLUGININFO_H