kjsembed.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 2005, 2006 Ian Reinhart Geiser <geiseri@kde.org>
    Copyright (C) 2005, 2006 Matt Broadstone <mbroadst@gmail.com>
    Copyright (C) 2005, 2006 Richard J. Moore <rich@kde.org>
    Copyright (C) 2005, 2006 Erik L. Bunce <kde@bunce.us>

    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 KJSEMBED_H
#define KJSEMBED_H

class QObject;

#include <kjsembed/kjseglobal.h>
#include <kjs/object.h>
#include <kdemacros.h>

namespace KJS {
    class Interpreter;
    class Object;
    class Completion;
}

namespace KJSEmbed {

class KJSEMBED_EXPORT Engine
{
public:
    enum ExitStatus { Success = 0, Failure = 1 };

    Engine( bool enableBindings = true);
    virtual ~Engine();

    bool isBindingsEnabled() const;

    ExitStatus runFile( const KJS::UString &file );

    static KJS::Completion runFile( KJS::Interpreter *interpreter, const KJS::UString &file );

    ExitStatus execute( const KJS::UString &code );

    KJS::Completion completion() const;

    KJS::Interpreter *interpreter() const;

    KJS::JSObject *addObject( QObject *obj, const KJS::UString &name = KJS::UString() ) const;

    KJS::JSObject *addObject( QObject *obj, KJS::JSObject *parent, const KJS::UString &name = KJS::UString()) const;

    KJS::JSObject *construct( const KJS::UString &className, const KJS::List &args = KJS::List() ) const;

    KJS::JSValue *callMethod( const KJS::UString &methodName, const KJS::List &args = KJS::List() );

    KJS::JSValue *callMethod( KJS::JSObject *parent, const KJS::UString &methodName, const KJS::List &args = KJS::List() );

private:
    class EnginePrivate *dptr;
};

}

#endif

//kate: indent-spaces on; indent-width 4; replace-tabs on; indent-mode cstyle;