jsfactory.h

Go to the documentation of this file.

// -*- c++ -*-

/*
 *  Copyright (C) 2001-2004, 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 KJSEMBEDFACTORY_H
#define KJSEMBEDFACTORY_H

#include <qmap.h>
#include <qdict.h>
#include <qstringlist.h>

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

class QEvent;
class QObject;
class QWidget;
class QTextStream;

namespace KParts {
    class ReadOnlyPart;
    class ReadWritePart;
}

namespace KJSEmbed {

namespace Bindings { class JSFactoryImp;
    class JSBindingPlugin; }

class KJSEmbedPart;
class JSEventMapper;
class JSOpaqueProxy;
class JSObjectProxy;

class JSFactory
{
public:
    enum ProxyTypes {
        TypeInvalid=0,
        TypeQObject=1,
        TypeValue=2,
        TypeOpaque=4,
        TypePlugin=8,
        TypeQObjectPlugin=9 /*TypeObject|TypePlugin*/
    };

    JSFactory( KJSEmbedPart *part );

    virtual ~JSFactory();

    JSEventMapper *eventMapper() const { return evmapper; }

    KJSEmbedPart *part() const { return jspart; }

    //
    // Methods for creating objects and wrappers.
    //

    KJS::Object create( KJS::ExecState *exec, const QString &classname, const KJS::List &args );

    KJS::Object createProxy( KJS::ExecState *exec, QObject *target,
                             const JSObjectProxy *context=0 ) const;

    KJS::Object createProxy( KJS::ExecState *exec, QTextStream *target,
                             const JSObjectProxy *context=0 ) const;

    KJS::Object createProxy( KJS::ExecState *exec, QEvent *target,
                             const JSObjectProxy *context ) const;

    //
    // Methods for creating custom objects.
    //

    KParts::ReadOnlyPart *createROPart( const QString &svc, QObject *parent=0, const char *name=0 );

    KParts::ReadOnlyPart *createROPart( const QString &svc, const QString &constraint,
                                        QObject *parent=0, const char *name=0 );
    
    KParts::ReadWritePart *createRWPart( const QString &svc, QObject *parent=0, const char *name=0 );

    KParts::ReadWritePart *createRWPart( const QString &svc, const QString &constraint,
                                         QObject *parent=0, const char *name=0 );

    QWidget *loadUI( const QString &uiFile, QObject *connector=0, QWidget *parent=0, const char *name=0 );

    QStringList listBindingPlugins( KJS::ExecState *exec, KJS::Object &self);
    //
    // Methods that tell the factory how to handle different classes.
    //
    void addBindingPluginTypes(KJS::ExecState *exec, KJS::Object &parent);
    bool isBindingPlugin(const QString &classname) const;
    KJS::Object createBindingPlugin(KJS::ExecState *exec, const QString &classname, const KJS::List &args );
    bool isSupported( const QString &clazz ) const;

    bool isQObject( const QString &clazz ) const;

    bool isValue( const QString &clazz ) const;

    bool isOpaque( const QString &clazz ) const;

    uint proxyType( const QString &clazz ) const;


    void addQObjectPlugin(const QString &classname, KJSEmbed::Bindings::JSBindingPlugin* plugin);

    void addBindingsPlugin(KJS::ExecState *exec, KJS::Object &target) const;

    void addType( const QString &clazz, uint proxytype=JSFactory::TypeQObject );

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

    QStringList types() const;
    
protected:
    KJS::Object extendProxy( KJS::ExecState *exec, KJS::Object &target ) const;
    
    KJS::Object createValue( KJS::ExecState *exec, const QString &cname, const KJS::List &args );

    QObject *create( const QString &classname, QObject *parent=0, const char *name=0  );

    KJS::Object createOpaque( KJS::ExecState *exec, const QString &cname, const KJS::List &args );


    QObject *createBinding( const QString &cname, QObject *parent, const char *name );

    QObject *createObject( const QString &cname, QObject *parent, const char *name );

    QWidget *createWidget( const QString &cname, QWidget *parent, const char *name );

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

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

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

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

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

    void addValueTypes( KJS::ExecState *exec, KJS::Object &parent );
    
private:
    KJSEmbedPart *jspart;
    JSEventMapper *evmapper;
    QMap<QString,uint> objtypes;
    class JSFactoryPrivate *d;
};

} // namespace KJSEmbed

#endif // KJSEMBEDFACTORY_H

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

---