kopetepluginmanager.h

Go to the documentation of this file.

/*
    kopetepluginmanager.h - Kopete Plugin Loader

    Copyright (c) 2002-2003 by Duncan Mac-Vicar Prett <duncan@kde.org>
    Copyright (c) 2002-2003 by Martijn Klingens       <klingens@kde.org>

    Kopete    (c) 2002-2003 by the Kopete developers  <kopete-devel@kde.org>

    *************************************************************************
    *                                                                       *
    * This library is free software; you can redistribute it and/or         *
    * modify it under the terms of the GNU Lesser General Public            *
    * License as published by the Free Software Foundation; either          *
    * version 2 of the License, or (at your option) any later version.      *
    *                                                                       *
    *************************************************************************
*/

#ifndef KOPETEPLUGINMANAGER_H
#define KOPETEPLUGINMANAGER_H

#include <QtCore/QObject>
#include <QtCore/QList>
#include "kopete_export.h"

class KPluginInfo;

namespace Kopete
{

class Plugin;
class Protocol;
typedef QList<Plugin*> PluginList;
class PluginManagerPrivate;

class KOPETE_EXPORT PluginManager : public QObject
{
    friend class PluginManagerPrivate;
    Q_OBJECT
    Q_ENUMS( PluginLoadMode )

public:
    static PluginManager* self();

    QList<KPluginInfo> availablePlugins( const QString &category = QString() ) const;

    PluginList loadedPlugins( const QString &category = QString() ) const;

    Plugin *plugin( const QString &pluginName ) const;

    KPluginInfo pluginInfo( const Kopete::Plugin *plugin ) const;


    void shutdown();

    bool setPluginEnabled( const QString &name, bool enabled = true );

    bool isAllPluginsLoaded() const;

    enum PluginLoadMode { LoadSync, LoadAsync };

public slots:
    Plugin *loadPlugin( const QString &pluginId, PluginLoadMode mode = LoadSync );

    bool unloadPlugin( const QString &pluginName );

    void loadAllPlugins();

signals:
    void pluginLoaded( Kopete::Plugin *plugin );

    void pluginUnloaded( const QString &pluginName );

    void protocolLoaded( Kopete::Protocol *protocol );

    void allPluginsLoaded();

private slots:
    void slotPluginDestroyed( QObject *plugin );

    void slotShutdownTimeout();

    void slotShutdownDone();

    void slotPluginReadyForUnload();

    void slotLoadNextPlugin();

private:
    Plugin * loadPluginInternal( const QString &pluginId );

    KPluginInfo infoForPluginId( const QString &pluginId ) const;

    PluginManager();
    ~PluginManager();

};

}

#endif // KOPETEPLUGINMANAGER_H

// vim: set noet ts=4 sts=4 sw=4: