KParts::ScriptableExtension Class Reference

#include <scriptableextension.h>

Inheritance diagram for KParts::ScriptableExtension:

Classes
struct	Exception
struct	FunctionRef
struct	Null
struct	Object
struct	Undefined

Object Operations
All these methods share the following conventions: Values are passed and returned encoded as defined in Script Value Types All methods may return an exception if unsupported All callers must provide an accurate callerPrincipal argument describing which ScriptableExtension (and hence which KPart) they're acting as. This is used to implement security checks. This is not the same as the owner of an object. For example, if a plugin is calling an operation on a KHTMLPart object, then the 'this' parameter would be the object owner, a ScriptableExtension provided by the KHTMLPart, while the callerPrincipal would be the ScriptableExtension of the plugin. The extension is expected to do appropriate cross-site scripting checks on this argument if it is acting as a host.
enum	ScriptLanguage { ECMAScript , EnumLimit = 0xFFFF }
typedef QList< QVariant >	ArgList
virtual QVariant	callAsFunction (ScriptableExtension *callerPrincipal, quint64 objId, const ArgList &args)
virtual QVariant	callFunctionReference (ScriptableExtension *callerPrincipal, quint64 objId, const QString &f, const ArgList &args)
virtual QVariant	callAsConstructor (ScriptableExtension *callerPrincipal, quint64 objId, const ArgList &args)
virtual bool	hasProperty (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName)
virtual QVariant	get (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName)
virtual bool	put (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName, const QVariant &value)
virtual bool	removeProperty (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName)
virtual bool	enumerateProperties (ScriptableExtension *callerPrincipal, quint64 objId, QStringList *result)
virtual bool	setException (ScriptableExtension *callerPrincipal, const QString &message)
virtual QVariant	evaluateScript (ScriptableExtension *callerPrincipal, quint64 contextObjectId, const QString &code, ScriptLanguage language=ECMAScript)
virtual bool	isScriptLanguageSupported (ScriptLanguage lang) const
virtual void	acquire (quint64 objid)
virtual void	release (quint64 objid)
static QVariant	acquireValue (const QVariant &v)
static QVariant	releaseValue (const QVariant &v)

lifetime
	ScriptableExtension (QObject *parent)
virtual	~ScriptableExtension ()
static ScriptableExtension *	childObject (QObject *obj)
static ScriptableExtension *	adapterFromLiveConnect (QObject *parentObj, LiveConnectExtension *oldApi)

Object Hierarchy
void	setHost (ScriptableExtension *host)
ScriptableExtension *	host () const
virtual QVariant	rootObject ()
QVariant	enclosingObject ()

Detailed Description

An extension class that permits KParts to be scripted (such as when embedded inside a KHTMLPart) and to access the host's scriptable objects as well.

See Script Value Types for how values are passed to/from various methods here.

Since

4.5

Definition at line 44 of file scriptableextension.h.

---

The documentation for this class was generated from the following files:

• scriptableextension.h
• scriptableextension.cpp