You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
197 lines
7.0 KiB
197 lines
7.0 KiB
/*
|
|
* 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., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef KJSEMBEDJSOBJECTPROXY_H
|
|
#define KJSEMBEDJSOBJECTPROXY_H
|
|
#include "global.h"
|
|
#include <tqguardedptr.h>
|
|
#include <tqcstring.h>
|
|
#include <tqwidget.h>
|
|
|
|
#include <kjs/object.h>
|
|
#include <kjsembed/jsproxy.h>
|
|
#include <kjsembed/jsbinding.h>
|
|
|
|
namespace KJS { class Interpreter; }
|
|
|
|
namespace KJSEmbed {
|
|
|
|
namespace Bindings { class JSObjectProxyImp; }
|
|
|
|
class JSSecurityPolicy;
|
|
class KJSEmbedPart;
|
|
class JSObjectEventProxy;
|
|
|
|
/**
|
|
* A JS object that provides a binding to a TQObject.
|
|
* <h3>Introduction</h3>
|
|
* This class defines a @ref KJS::ObjectImp that allows scripts to access
|
|
* the properties of a TQObject. The scripts can also create child objects,
|
|
* load dialogs from .ui files created by Designer and navigate the object
|
|
* tree in a similar manner to the DCOP/TQObject bridge.
|
|
* <h3>Example Usage</h3>
|
|
* The following example creates a @ref KJS::ObjectImp that provides
|
|
* a binding to the properties of a @ref TQLineEdit . This binding is
|
|
* then used to create a property 'edit' for the object 'jsparent'.
|
|
* <pre>
|
|
*
|
|
* TQLineEdit *edit = new TQLineEdit();
|
|
* KJSEmbed::JSObjectProxy *proxy = new KJSEmbed::JSObjectProxy( js, edit );
|
|
* jsparent.put( js->globalExec(), "edit", proxy );
|
|
*
|
|
* </pre>
|
|
*
|
|
* <h3>Security Facilities</h3>
|
|
* In order to ensure scripts don't run amok and to ensure the script
|
|
* interpreter used by TDEHTML remains secure, JSObjectProxy applies a
|
|
* security policy. Every time a script tries to access an object or
|
|
* property the following tests are performed:
|
|
* <ul>
|
|
* <li>Does this request come from the correct @ref KJS::Interpreter?
|
|
* <li>Is the script allowed to access the specified TQObject?
|
|
* <li>Is the script allowed to access the specified property?
|
|
* </ul>
|
|
* The @ref KJSEmbed::JSSecurityPolicy class decides if the request should
|
|
* be granted. The security policy is automatically inherited by any child
|
|
* proxies created using the object tree accessor methods.
|
|
*
|
|
* @see KJSEmbed::JSFactory
|
|
* @author Richard Moore, rich@kde.org
|
|
* $Id$
|
|
*/
|
|
class KJSEMBED_EXPORT JSObjectProxy : public JSProxy
|
|
{
|
|
public:
|
|
/**
|
|
* Create a JS binding to the target object. The binding will allow scripts to
|
|
* access any TQObject that is descended the target and no others.
|
|
*/
|
|
JSObjectProxy( KJSEmbedPart *part, TQObject *target );
|
|
|
|
/**
|
|
* Create a JS binding to the target object. The binding will allow scripts to
|
|
* access any TQObject that is descended from the specified root. If the specified
|
|
* root is 0 then access is granted to all objects.
|
|
*/
|
|
JSObjectProxy( KJSEmbedPart *part, TQObject *target, TQObject *root );
|
|
|
|
/**
|
|
* Create a JS binding to the target object. The binding will allow scripts to
|
|
* access any TQObject that is descended from the specified root, according to
|
|
* the specified @ref JSSecurityPolicy . If the specified root is 0 then access
|
|
* is granted to all objects.
|
|
*/
|
|
JSObjectProxy( KJSEmbedPart *part, TQObject *target, TQObject *root, const JSSecurityPolicy *sp );
|
|
|
|
virtual ~JSObjectProxy();
|
|
|
|
/** Returns the KJSEmbedPart in which this proxy lives. */
|
|
KJSEmbedPart *part() const { return jspart; }
|
|
|
|
/** Returns the interpreter in which this proxy lives. */
|
|
KJS::Interpreter *interpreter() const { return js; }
|
|
|
|
/** Returns the root object that defines the limit of the scope of this proxy. */
|
|
TQObject *rootObject() const { return root; }
|
|
|
|
/** Returns the TQObject the proxy is attached to. */
|
|
TQObject *object() const { return obj; }
|
|
|
|
/** Returns the className of the proxied object */
|
|
TQString typeName() const { return obj->className(); }
|
|
|
|
/** Returns the associated TQWidget, or 0 if the object is not a widget. */
|
|
TQWidget *widget() const
|
|
{
|
|
TQObject *w = obj;
|
|
return (w && w->isWidgetType()) ? static_cast<TQWidget *>(w) : 0;
|
|
}
|
|
|
|
//void *toVoidStar() { return obj; }
|
|
//template<class T>
|
|
//T *toNative(){ return dynamic_cast<TQObject*>(obj); }
|
|
|
|
/** Returns true iff the content of this proxy inherits the specified base-class. */
|
|
bool inherits( const char *clazz ) { return obj->isA( clazz ); }
|
|
|
|
/** Returns the @ref JSSecurityPolicy of the proxy. */
|
|
const JSSecurityPolicy *securityPolicy() const { return policy; }
|
|
|
|
/**
|
|
* Specifies the @ref JSSecurityPolicy that should be applied to this proxy.
|
|
* Setting the policy to 0 restores the default policy.
|
|
*/
|
|
void setSecurityPolicy( const JSSecurityPolicy *sp );
|
|
|
|
/** Reimplemented to return the value of the specified property if present. */
|
|
virtual KJS::Value get( KJS::ExecState *exec, const KJS::Identifier &p ) const;
|
|
|
|
/** Reimplemented to set the value of the specified property if possible. */
|
|
virtual void put( KJS::ExecState *exec, const KJS::Identifier &p,
|
|
const KJS::Value &v, int attr = KJS::None );
|
|
|
|
/** Reimplemented to return the name and class of the target. */
|
|
virtual KJS::UString toString( KJS::ExecState *exec ) const;
|
|
|
|
/**
|
|
* Adds methods for traversing the TQObject tree to the specified
|
|
* @ref KJS::Object . Only TQObjects descended from the root specified
|
|
* in the constructor can be reached through JS proxies created with
|
|
* these bindings.
|
|
* <ul>
|
|
* <li>properties()
|
|
* <li>create(...)
|
|
* </ul>
|
|
*/
|
|
virtual void addBindings( KJS::ExecState *exec, KJS::Object &object );
|
|
|
|
protected:
|
|
void addBindingsClass( KJS::ExecState *exec, KJS::Object &object );
|
|
|
|
/**
|
|
* Adds bindings for the constants defined by enums of the target.
|
|
*/
|
|
void addBindingsEnum( KJS::ExecState *exec, KJS::Object &object );
|
|
|
|
/**
|
|
* Adds bindings for slots defined by the target of the proxy.
|
|
*/
|
|
void addBindingsSlots( KJS::ExecState *exec, KJS::Object &object );
|
|
|
|
|
|
private:
|
|
bool isAllowed( KJS::Interpreter *js ) const;
|
|
|
|
void addSlotBinding( const TQCString &name, KJS::ExecState *exec, KJS::Object &object );
|
|
|
|
private:
|
|
KJSEmbedPart *jspart;
|
|
KJS::Interpreter *js;
|
|
TQGuardedPtr<TQObject> obj;
|
|
TQGuardedPtr<TQObject> root;
|
|
TQGuardedPtr<JSObjectEventProxy> evproxy;
|
|
const JSSecurityPolicy *policy;
|
|
class JSObjectProxyPrivate *d;
|
|
friend class Bindings::JSObjectProxyImp;
|
|
};
|
|
|
|
} // namespace KJSEmbed
|
|
|
|
#endif // KJSEMBEDJSOBJECTPROXY_H
|