plugin.h

Go to the documentation of this file.

#ifndef KIPI_PLUGIN_H
#define KIPI_PLUGIN_H

// Qt includes

#include <QtCore/QObject>
#include <QtCore/QList>
#include <QtCore/QHash>
#include <QtXml/QDomElement>
#include <QtXml/QDomNode>
#include <QtXml/QDomDocument>

// KDE includes

#include <kxmlguiclient.h>

// Local includes

#include "libkipi_export.h"

class KAction;
class KActionCollection;
class KComponentData;

namespace KIPI
{

class Interface;

enum Category
{
    InvalidCategory = -1,
    ImagesPlugin    = 0,
    ToolsPlugin,
    ImportPlugin,
    ExportPlugin,
    BatchPlugin,
    CollectionsPlugin
};

class LIBKIPI_EXPORT Plugin : public QObject, public KXMLGUIClient
{
    Q_OBJECT

    typedef QList<QDomElement>                        QDomElemList;
    typedef QHash<QString, QDomElemList>              QHashPath;
    typedef QMap<QWidget*, QMap<KAction*, Category> > ActionCategoryMap;

public:

    Plugin(const KComponentData& instance, QObject* const parent, const char* name);

    virtual ~Plugin();

    QList<KAction*> actions(QWidget* const widget = 0) const;

    Interface* interface() const;

    virtual void setup(QWidget* const widget) = 0;

    Category category(KAction* const action) const;

    void rebuild();

protected:

    void addAction(const QString& name, KAction* const action);

    void addAction(const QString& name, KAction* const action, Category cat);

    void setDefaultCategory(Category cat);

    Category defaultCategory() const;

    void setUiBaseName(const char* name);

    QString uiBaseName() const;

    void setupXML();

private:

    void addAction(KAction* const action);
    void addAction(KAction* const action, Category cat);

    void mergeXMLFile(KXMLGUIClient* const host);
    void clearActions();

private:

    class Private;
    Private* const d;
};

} // namespace KIPI

#endif  // KIPI_PLUGIN_H