ui/plugin.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2008 Paulo Moura Guedes <moura@kdewebdev.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 KROSS_PLUGIN_H
#define KROSS_PLUGIN_H

#include <kparts/plugin.h>

#include <kross/core/krossconfig.h>
#include <kross/core/childreninterface.h>

namespace Kross {
    class ActionCollection;
}

class QWidget;

namespace Kross
{

class KROSSUI_EXPORT ScriptingPlugin : public KParts::Plugin
{
    Q_OBJECT
public:

    explicit ScriptingPlugin(QObject* parent = 0);

    ScriptingPlugin(const QString& collectionName, const QString& userActionsFile, const QString& referenceActionsDir=QString(), QObject* parent=0);

    virtual ~ScriptingPlugin();

    virtual void setDOMDocument (const QDomDocument &document, bool merge = false);

    void addObject(QObject* object, const QString& name/* = QString()*/, ChildrenInterface::Options options/* = ChildrenInterface::NoOption*/);
    
    void addObject(QObject* object, const QString& name = QString()); //BIC

protected Q_SLOTS:

    virtual void slotEditScriptActions();

    virtual void slotResetScriptActions();

private:
    QDomDocument buildDomDocument(const QDomDocument& document);
    void buildDomDocument(QDomDocument& document, Kross::ActionCollection* collection);
    void save();

private:
    class ScriptingPluginPrivate;
    ScriptingPluginPrivate* const d;
};

}

#endif