scriptcontainer.h

/***************************************************************************
 * scriptcontainer.h
 * This file is part of the KDE project
 * copyright (C)2004-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_SCRIPTCONTAINER_H
#define KROSS_API_SCRIPTCONTAINER_H
 
#include "mainmodule.h"
 
#include <tqstring.h>
#include <tqvariant.h>
#include <tqobject.h>
#include <ksharedptr.h>
 
namespace Kross { namespace Api {
 
    // Forward declarations.
    class Object;
    class List;
    class ScriptContainerPrivate;

    class KOFFICE_EXPORT ScriptContainer : public MainModule
    {
            // We protected the constructor cause ScriptContainer
            // instances should be created only within the
            // Manager::getScriptContainer() method.
            friend class Manager;
 
        protected:

            explicit ScriptContainer(const TQString& name = TQString());
 
        public:

            typedef TDESharedPtr<ScriptContainer> Ptr;

            virtual ~ScriptContainer();

            const TQString getName() const;

            void setName(const TQString& name);

            TQString getCode() const;

            void setCode(const TQString& code);

            TQString getInterpreterName() const;

            void setInterpreterName(const TQString& interpretername);

            TQString getFile() const;

            void setFile(const TQString& scriptfile);

            TQStringVariantMap& getOptions();

            TQVariant getOption(const TQString name, TQVariant defaultvalue = TQVariant(), bool recursive = false);

            bool setOption(const TQString name, const TQVariant& value);

            Object::Ptr execute();

            const TQStringList getFunctionNames();

            TDESharedPtr<Object> callFunction(const TQString& functionname, TDESharedPtr<List> arguments = 0);

            TQStringList getClassNames();

            TDESharedPtr<Object> classInstance(const TQString& classname);

            bool initialize();

            void finalize();
 
        private:
            ScriptContainerPrivate* d;
    };
 
}}
 
#endif