kjsembedpart.h

Go to the documentation of this file.

// -*- c++ -*-

/*
 *  Copyright (C) 2001-2003, Richard J. Moore <rich@kde.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., 59 Temple Place - Suite 330,
 *  Boston, MA 02111-1307, USA.
 */

#ifndef KJSEMBEDJSCONSOLEPART_H
#define KJSEMBEDJSCONSOLEPART_H

#include <qstringlist.h>

#ifndef QT_ONLY
#include <kparts/part.h>
#endif

#include <kjs/interpreter.h>
#include <kjs/object.h>
#include <kjs/value.h>

#include <kjsembed/jsbinding.h>

#ifndef QT_ONLY
#include <kjsembed/xmlactionclient.h>
#else
#include <kjsembed/qtstubs.h>
#endif

class QWidget;

#define KJSEMBED_VERSION_STRING "0.3"
#define KJSEMBED_VERSION_MAJOR 0
#define KJSEMBED_VERSION_MINOR 3

namespace KJSEmbed {

class JSObjectProxy;
class JSConsoleWidget;
class JSFactory;
class JSBuiltIn;

class KJSEmbedPart : public KParts::ReadOnlyPart
{
    Q_OBJECT
    Q_PROPERTY( QStringList constructorNames READ constructorNames )
    Q_PROPERTY( QCString versionString READ versionString )
    Q_PROPERTY( int versionMajor READ versionMajor )
    Q_PROPERTY( int versionMinor READ versionMinor )

public:
    KJSEmbedPart( QObject *parent=0, const char *name=0 );

    KJSEmbedPart( QWidget *wparent, const char *wname=0, QObject *parent=0, const char *name=0 );

    KJSEmbedPart( KJS::Interpreter *js, QWidget *wparent, const char *wname=0,
                  QObject *parent=0, const char *name=0 );

    virtual ~KJSEmbedPart();

    //
    // Version information
    //

    QCString versionString() const;

    int versionMajor() const;

    int versionMinor() const;

    //
    // Script environment.
    //
    
    bool hasMethod( const QString &methodName );
    
    KJS::Value callMethod(const QString &methodName, const KJS::List &args) const;
    KJS::Value getValue( const QString &valueName ) const;
    
    void putValue( const QString &valueName, const KJS::Value &value);

    void putVariant( const QString &valueName, const QVariant &value);
    
    QVariant getVariant( const QString &valueName ) const;
    
    KJS::Object globalObject() const { return js->globalObject(); }

    KJS::Completion completion() const { return res; }

    KJS::Object partObject() const { return partobj; }

    KJS::Object addObject( QObject *obj, const char *name=0 );

    KJS::Object addObject( QObject *obj, KJS::Object &parent, const char *name=0 );

    KJS::Object bind( QObject *obj );

    //
    // Query the supported types
    //

    QStringList constructorNames() const;

    KJS::Value constructors() const;

    KJS::List constructorList() const;

public slots:
    //
    // Reimplement the KPart API.
    //

    virtual KJSEmbed::JSConsoleWidget *view();

    virtual bool openURL( const KURL &url );

    //
    // XML Action Handling
    //

    KJSEmbed::XMLActionClient *actionClient() const { return xmlclient; }

    bool loadActionSet( const QString &file );

    //
    // Script environemnt
    //

    KJS::Interpreter *interpreter() const { return js; }

    KJS::ExecState *globalExec() const { return js->globalExec(); }

    JSFactory *factory() const { return jsfactory; }

    virtual KJS::Value evaluate( const QString &script, const KJS::Value &self=KJS::Null() );

    bool execute( const QString &script, const KJS::Value &self=KJS::Null() );

    virtual bool execute( KJS::Completion &result, const QString &script, const KJS::Value &self );

    virtual bool runFile( const QString &filename, const KJS::Value &self=KJS::Null() );

    QString loadFile( const QString &file );

protected:
    void createInterpreter();

    void createBuiltIn( KJS::ExecState *exec, KJS::Object &parent );

    void createActionClient();

    virtual bool openFile() { return false; }

    virtual void virtual_hook( int id, void *data );

private:
    XMLActionClient *xmlclient;
    JSConsoleWidget *jsConsole;
    JSFactory *jsfactory;
    JSBuiltIn *builtins;
    QWidget *widgetparent;
    QCString widgetname;

    KJS::Object partobj;
    KJS::Completion res;
    KJS::Interpreter *js;
    bool deletejs;

    class KJSEmbedPartPrivate *d;
};


} // namespace KJSEmbed

#endif // KJSEMBEDJSCONSOLEPART_H

// Local Variables:
// c-basic-offset: 4
// End:

---