scriptguiclient.h

/***************************************************************************
 * scriptguiclient.h
 * This file is part of the KDE project
 * copyright (C) 2005 by Sebastian Sauer (mail@dipe.org)
 *
 * This program 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 program 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 program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 ***************************************************************************/
 
#ifndef KROSS_API_SCRIPTGUICLIENT_H
#define KROSS_API_SCRIPTGUICLIENT_H
 
#include "scriptcontainer.h"
#include "scriptaction.h"
 
#include <tqobject.h>
#include <tqdom.h>
#include <kurl.h>
#include <kxmlguiclient.h>
 
class TQWdiget;
 
namespace Kross { namespace Api {
 
    // Forward declarations.
    class ScriptAction;
    class ScriptGUIClientPrivate;

    class TDE_EXPORT ScriptGUIClient
        : public TQObject
        , public KXMLGUIClient
    {
            TQ_OBJECT
  
            //TQ_PROPERTY(TQString configfile READ getConfigFile WRITE setConfigFile)
 
        public:

            typedef TQPtrList<TDEAction> List;

            explicit ScriptGUIClient(KXMLGUIClient* guiclient, TQWidget* parent = 0);

            virtual ~ScriptGUIClient();

            bool hasActionCollection(const TQString& name);

            ScriptActionCollection* getActionCollection(const TQString& name);

            TQMap<TQString, ScriptActionCollection*> getActionCollections();

            void addActionCollection(const TQString& name, ScriptActionCollection* collection);

            bool removeActionCollection(const TQString& name);

            void reloadInstalledScripts();

            bool installScriptPackage(const TQString& scriptpackagefile);

            bool uninstallScriptPackage(const TQString& scriptpackagepath);

            bool loadScriptConfigFile(const TQString& scriptconfigfile);

            bool loadScriptConfigDocument(const TQString& scriptconfigfile, const TQDomDocument &document);

            virtual void setXMLFile(const TQString& file, bool merge = false, bool setXMLDoc = true);
            virtual void setDOMDocument(const TQDomDocument &document, bool merge = false);
 
        public slots:

            KURL openScriptFile(const TQString& caption = TQString());

            bool loadScriptFile();

            bool executeScriptFile();

            bool executeScriptFile(const TQString& file);

            bool executeScriptAction(ScriptAction::Ptr action);

            void showScriptManager();
 
        private slots:

            void executionFailed(const TQString& errormessage, const TQString& tracedetails);

            void successfullyExecuted();
 
        signals:
            void collectionChanged(ScriptActionCollection*);
            void executionStarted(const Kross::Api::ScriptAction* );
            void executionFinished(const Kross::Api::ScriptAction* );
        private:
            ScriptGUIClientPrivate* d;
    };
 
}}
 
#endif